express-ext 0.4.0 → 0.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-ext",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "express-ext",
   "main": "./lib/index.js",
   "types": "./src/index.ts",

package/src/GenericController.ts

@@ -1,25 +1,25 @@
-import { Request, Response } from 'express';
-import { checkId, create, isTypeError, update } from './edit';
-import { handleError, Log } from './http';
-import { LoadController } from './LoadController';
-import { Attribute, Attributes, ErrorMessage } from './metadata';
-import { resources, StringMap } from './resources';
-import { buildAndCheckId, buildId } from './view';
+import { Request, Response } from "express"
+import { checkId, create, isTypeError, update } from "./edit"
+import { handleError, Log } 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 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?(): 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>;
+  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> {
-  metadata?: Attributes;
-  returnNumber?: boolean;
+  metadata?: Attributes
+  returnNumber?: boolean
   constructor(
     log: Log,
     public service: GenericService<T, ID, number | T | ErrorMessage[]>,
@@ -27,50 +27,50 @@ export class GenericController<T, ID> extends LoadController<T, ID> {
     public validate?: Validate<T>,
     returnNumber?: boolean,
   ) {
-    super(log, service);
-    this.returnNumber = returnNumber;
+    super(log, service)
+    this.returnNumber = returnNumber
     if (service.metadata) {
-      const m = service.metadata();
+      const m = service.metadata()
       if (m) {
-        this.metadata = m;
+        this.metadata = m
       }
     }
-    this.create = this.create.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
     }
   }
   create(req: Request, res: Response): void {
-    validateAndCreate(req, res, this.service.create, this.log, this.validate, this.build);
+    validateAndCreate(req, res, this.service.create, this.log, this.validate, this.build)
   }
   update(req: Request, res: Response): void {
-    const id = buildAndCheckIdWithBody<T, ID, any>(req, res, this.keys, this.service.update);
+    const id = buildAndCheckIdWithBody<T, ID, any>(req, res, this.keys, this.service.update)
     if (id) {
-      validateAndUpdate(res, req.body, false, this.service.update, this.log, this.validate, undefined, this.build);
+      validateAndUpdate(res, req.body, false, this.service.update, this.log, this.validate, undefined, this.build)
     }
   }
   patch(req: Request, res: Response): void {
-    const id = buildAndCheckIdWithBody<T, ID, any>(req, res, this.keys, this.service.patch);
+    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.log, this.validate, undefined, this.build);
+      validateAndUpdate(res, req.body, true, this.service.patch, this.log, this.validate, undefined, this.build)
     }
   }
   delete(req: Request, res: Response): void {
-    const id = buildAndCheckId<ID>(req, res, this.keys);
+    const id = buildAndCheckId<ID>(req, res, this.keys)
     if (id) {
       if (!this.service.delete) {
-        res.status(405).end('Method Not Allowed');
+        res.status(405).end("Method Not Allowed")
       } else {
         this.service
           .delete(id)
           .then((count) => {
-            res.status(getDeleteStatus(count)).json(count).end();
+            res.status(getDeleteStatus(count)).json(count).end()
           })
-          .catch((err) => handleError(err, res, this.log));
+          .catch((err) => handleError(err, res, this.log))
       }
     }
   }
@@ -84,25 +84,25 @@ export function validateAndCreate<T>(
   build?: Build<T>,
   returnNumber?: boolean,
 ): void {
-  const obj = req.body;
-  if (!obj || obj === '') {
-    res.status(400).end('The request body cannot be empty.');
+  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();
+            res.status(getStatusCode(errors)).json(errors).end()
           } else {
             if (build) {
-              build(res, obj, true);
+              build(res, obj, true)
             }
-            create(res, obj, save, log, returnNumber);
+            create(res, obj, save, log, returnNumber)
           }
         })
-        .catch((err) => handleError(err, res, log));
+        .catch((err) => handleError(err, res, log))
     } else {
-      create(res, obj, save, log, returnNumber);
+      create(res, obj, save, log, returnNumber)
     }
   }
 }
@@ -121,76 +121,76 @@ export function validateAndUpdate<T>(
     validate(obj, resource, isPatch)
       .then((errors) => {
         if (errors && errors.length > 0) {
-          res.status(getStatusCode(errors)).json(errors).end();
+          res.status(getStatusCode(errors)).json(errors).end()
         } else {
           if (build) {
-            build(res, obj, false, isPatch);
+            build(res, obj, false, isPatch)
           }
-          update(res, obj, save, log, returnNumber);
+          update(res, obj, save, log, returnNumber)
         }
       })
-      .catch((err) => handleError(err, res, log));
+      .catch((err) => handleError(err, res, log))
   } else {
-    update(res, obj, save, log, returnNumber);
+    update(res, obj, save, log, returnNumber)
   }
 }
 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;
+  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;
+    res.status(405).end("Method Not Allowed")
+    return undefined
   }
-  const id = buildId<ID>(req, keys);
+  const id = buildId<ID>(req, keys)
   if (!id) {
-    res.status(400).end('Invalid parameters');
-    return undefined;
+    res.status(400).end("Invalid parameters")
+    return undefined
   }
-  const ok = checkId<T, ID>(obj, id, keys);
+  const ok = checkId<T, ID>(obj, id, keys)
   if (!ok) {
-    res.status(400).end('body and url are not matched');
-    return undefined;
+    res.status(400).end("body and url are not matched")
+    return undefined
   }
-  return id;
+  return id
 }
 export function getDeleteStatus(count: number): number {
   if (count > 0) {
-    return 200;
+    return 200
   } else if (count === 0) {
-    return 404;
+    return 404
   } else {
-    return 409;
+    return 409
   }
 }
 export function getStatusCode(errs: ErrorMessage[]): number {
-  return isTypeError(errs) ? 400 : 422;
+  return isTypeError(errs) ? 400 : 422
 }
 export interface ModelConfig {
-  id?: string;
-  payload?: string;
-  user?: string;
-  updatedBy?: string;
-  updatedAt?: string;
-  createdBy?: string;
-  createdAt?: string;
-  version?: string;
+  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;
+    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> {
@@ -205,52 +205,52 @@ export class Builder<T> {
     public createdAt: string,
     public version: string,
   ) {
-    this.build = this.build.bind(this);
+    this.build = this.build.bind(this)
   }
   build(res: Response, obj: T, isCreate?: boolean, isPatch?: boolean): void {
-    const o: any = obj;
-    let usr = '';
+    const o: any = obj
+    let usr = ""
     if (this.user.length > 0) {
       if (this.payload.length > 0) {
-        const payload = res.locals[this.payload];
+        const payload = res.locals[this.payload]
         if (payload) {
-          usr = payload[this.user];
+          usr = payload[this.user]
         }
       } else {
-        usr = res.locals[this.user];
+        usr = res.locals[this.user]
       }
     }
     if (!usr) {
-      usr = '';
+      usr = ""
     }
-    const now = new Date();
+    const now = new Date()
     if (isCreate) {
       if (this.generate && this.id.length > 0) {
-        o[this.id] = this.generate();
+        o[this.id] = this.generate()
       }
       if (usr.length > 0) {
         if (this.createdAt.length > 0) {
-          o[this.createdAt] = now;
+          o[this.createdAt] = now
         }
         if (this.createdBy.length > 0) {
-          o[this.createdBy] = usr;
+          o[this.createdBy] = usr
         }
       }
       if (this.version.length > 0) {
-        o[this.version] = 1;
+        o[this.version] = 1
       }
     } else if (isPatch) {
-      const keys = Object.keys(o);
+      const keys = Object.keys(o)
       if (keys.length === 0) {
-        return;
+        return
       }
     }
     if (usr.length > 0) {
       if (this.updatedAt.length > 0) {
-        o[this.updatedAt] = now;
+        o[this.updatedAt] = now
       }
       if (this.updatedBy.length > 0) {
-        o[this.updatedBy] = usr;
+        o[this.updatedBy] = usr
       }
     }
   }

package/src/GenericSearchController.ts

@@ -1,21 +1,20 @@
-import { Request, Response } from 'express';
-import { Build, GenericController, GenericService } from './GenericController';
-import { handleError, Log } from './http';
-import { ErrorMessage } from './metadata';
-import { StringMap } from './resources';
-import { buildArray, Filter, format, fromRequest, getMetadataFunc, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult } from './search';
+import { Request, Response } from "express"
+import { Build, GenericController, GenericService } from "./GenericController"
+import { handleError, Log } 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 class GenericSearchController<T, ID, S extends Filter> extends GenericController<T, ID> {
-  config?: SearchConfig;
-  csv?: boolean;
-  dates?: string[];
-  numbers?: string[];
-  fields?: string;
-  excluding?: string;
-  array?: string[];
+  config?: SearchConfig
+  csv?: boolean
+  dates?: string[]
+  numbers?: string[]
+  excluding?: string
+  array?: string[]
   constructor(
     log: Log,
-    public find: (s: S, limit?: number, skip?: number | string, fields?: string[]) => Promise<SearchResult<T>>,
+    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>,
@@ -23,29 +22,25 @@ export class GenericSearchController<T, ID, S extends Filter> extends GenericCon
     dates?: string[],
     numbers?: string[],
   ) {
-    super(log, service, build, validate);
-    this.search = this.search.bind(this);
-    this.config = initializeConfig(config);
+    super(log, service, build, validate)
+    this.search = this.search.bind(this)
+    this.config = initializeConfig(config)
     if (this.config) {
-      this.csv = this.config.csv;
-      this.fields = this.config.fields;
-      this.excluding = this.config.excluding;
+      this.csv = this.config.csv
+      this.excluding = this.config.excluding
     }
-    if (!this.fields || this.fields.length === 0) {
-      this.fields = 'fields';
-    }
-    const m = getMetadataFunc(service, dates, numbers);
+    const m = getMetadataFunc(service, dates, numbers)
     if (m) {
-      this.dates = m.dates;
-      this.numbers = m.numbers;
+      this.dates = m.dates
+      this.numbers = m.numbers
     }
   }
   search(req: Request, res: Response) {
-    const s = fromRequest<S>(req, buildArray(this.array, this.fields, this.excluding));
-    const l = getParameters(s, this.config);
-    const s2 = format(s, this.dates, this.numbers);
+    const s = fromRequest<S>(req, buildArray(this.array, resources.fields, this.excluding))
+    const l = getParameters(s, this.config)
+    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, this.log));
+      .catch((err) => handleError(err, res, this.log))
   }
 }

package/src/HealthController.ts

@@ -1,17 +1,17 @@
-import {Request, Response} from 'express';
-import {health, 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)
   }
   check(req: Request, res: Response) {
-    health(this.checkers).then(r => {
-      if (r.status === 'UP') {
-        return res.status(200).json(r).end();
+    health(this.checkers).then((r) => {
+      if (r.status === "UP") {
+        return res.status(200).json(r).end()
       } else {
-        return res.status(500).json(r).end();
+        return res.status(500).json(r).end()
       }
-    });
+    })
   }
 }

package/src/LoadController.ts

@@ -1,89 +1,96 @@
-import {Request, Response} from 'express';
-import {attrs, handleError, Log, minimize, queryNumber, respondModel} from './http';
-import {Attribute, Attributes} from './metadata';
-import {buildAndCheckId, buildKeys} from './view';
+import { Request, Response } from "express"
+import { attrs, handleError, Log, minimize, queryNumber, respondModel } from "./http"
+import { Attribute, Attributes } from "./metadata"
+import { buildAndCheckId, buildKeys } from "./view"
 
 export interface ViewService<T, ID> {
-  metadata?(): Attributes|undefined;
-  load(id: ID, ctx?: any): Promise<T|null>;
+  metadata?(): Attributes | undefined
+  load(id: ID, ctx?: any): Promise<T | null>
 }
-export type Load<T, ID> = ((id: ID, ctx?: any) => Promise<T|null>);
-function getViewFunc<T, ID>(viewService: ViewService<T, ID> | Load<T, ID>): (id: ID, ctx?: any) => Promise<T|null> {
-  if (typeof viewService === 'function') {
-    return viewService;
+export type Load<T, ID> = (id: ID, ctx?: any) => Promise<T | null>
+function getViewFunc<T, ID>(viewService: ViewService<T, ID> | Load<T, ID>): (id: ID, ctx?: any) => Promise<T | null> {
+  if (typeof viewService === "function") {
+    return viewService
   }
-  return viewService.load;
+  return viewService.load
 }
-function getKeysFunc<T, ID>(viewService: ViewService<T, ID> | Load<T, ID>, keys?: Attributes|Attribute[]|string[]): Attribute[] | undefined {
+function getKeysFunc<T, ID>(viewService: ViewService<T, ID> | Load<T, ID>, keys?: Attributes | Attribute[] | string[]): Attribute[] | undefined {
   if (keys) {
     if (Array.isArray(keys)) {
       if (keys.length > 0) {
-        if (typeof keys[0] === 'string') {
-          return attrs(keys as string[]);
+        if (typeof keys[0] === "string") {
+          return attrs(keys as string[])
         } else {
-          return keys as Attribute[];
+          return keys as Attribute[]
         }
       }
-      return undefined;
+      return undefined
     } else {
-      return buildKeys(keys as Attributes);
+      return buildKeys(keys as Attributes)
     }
   }
-  if (typeof viewService !== 'function' && viewService.metadata) {
-    const metadata = viewService.metadata();
+  if (typeof viewService !== "function" && viewService.metadata) {
+    const metadata = viewService.metadata()
     if (metadata) {
-      return buildKeys(metadata);
+      return buildKeys(metadata)
     }
   }
-  return undefined;
+  return undefined
 }
 export class LoadController<T, ID> {
-  protected keys?: Attribute[];
-  protected view: Load<T, ID>;
-  constructor(protected log: Log, viewService: ViewService<T, ID> | Load<T, ID>, keys?: Attributes|Attribute[]|string[]) {
-    this.load = this.load.bind(this);
-    this.view = getViewFunc(viewService);
-    this.keys = getKeysFunc(viewService, keys);
+  protected keys?: Attribute[]
+  protected view: Load<T, ID>
+  constructor(protected log: Log, viewService: ViewService<T, ID> | Load<T, ID>, keys?: Attributes | Attribute[] | string[]) {
+    this.load = this.load.bind(this)
+    this.view = getViewFunc(viewService)
+    this.keys = getKeysFunc(viewService, keys)
   }
   load(req: Request, res: Response): void {
-    const id = buildAndCheckId<ID>(req, res, this.keys);
+    const id = buildAndCheckId<ID>(req, res, this.keys)
     if (id) {
       this.view(id)
-        .then(obj => respondModel(minimize(obj), res))
-        .catch(err => handleError(err, res, this.log));
+        .then((obj) => respondModel(minimize(obj), res))
+        .catch((err) => handleError(err, res, this.log))
     }
   }
 }
 // tslint:disable-next-line:max-classes-per-file
 export class ItemController<T> {
-  constructor(protected log: Log, private loadData: (keyword: string, max?: number) => Promise<T>, name?: string, protected param?: boolean, max?: number, maxName?: string) {
-    this.name = (name && name.length > 0 ? name : 'keyword');
-    this.max = (max && max > 0 ? max : 20);
-    this.maxName = (maxName && maxName.length > 0 ? maxName : 'max');
-    this.load = this.load.bind(this);
-    this.query = this.query.bind(this);
+  constructor(
+    protected log: Log,
+    private loadData: (keyword: string, max?: number) => Promise<T>,
+    name?: string,
+    protected param?: boolean,
+    max?: number,
+    maxName?: string,
+  ) {
+    this.name = name && name.length > 0 ? name : "keyword"
+    this.max = max && max > 0 ? max : 20
+    this.maxName = maxName && maxName.length > 0 ? maxName : "max"
+    this.load = this.load.bind(this)
+    this.query = this.query.bind(this)
   }
-  name: string;
-  max: number;
-  maxName: string;
+  name: string
+  max: number
+  maxName: string
   query(req: Request, res: Response) {
-    return this.load(req, res);
+    return this.load(req, res)
   }
   load(req: Request, res: Response) {
-    const v = this.param ? req.params[this.name] : req.query[this.name];
+    const v = this.param ? req.params[this.name] : req.query[this.name]
     if (!v) {
-      res.status(400).end(`'${this.name}' cannot be empty`);
+      res.status(400).end(`'${this.name}' cannot be empty`)
     } else {
-      const s = v.toString();
+      const s = v.toString()
       if (s.length === 0) {
-        res.status(400).end(`'${this.name}' cannot be empty`);
+        res.status(400).end(`'${this.name}' cannot be empty`)
       } else {
-        const max = queryNumber(req, this.maxName, this.max);
+        const max = queryNumber(req, this.maxName, this.max)
         this.loadData(s, max)
-          .then(result => respondModel(minimize(result), res))
-          .catch(err => handleError(err, res, this.log));
+          .then((result) => respondModel(minimize(result), res))
+          .catch((err) => handleError(err, res, this.log))
       }
     }
   }
 }
-export {ItemController as ItemHandler};
+export { ItemController as ItemHandler }