core-express 0.1.0 → 0.1.1

package/src/edit.ts

@@ -1,13 +1,13 @@
-import {Response} from 'express';
-import {Attribute, ErrorMessage} from './metadata';
-import {handleError} from './response';
-
+import { Response } from "express"
+import { handleError } from "./http"
+import { Attribute, ErrorMessage } from "./metadata"
+/*
 export interface StatusConfig {
-  duplicate_key?: number|string;
-  not_found?: number|string;
-  success?: number|string;
+  duplicate_key: number|string;
+  not_found: number|string;
+  success: number|string;
   version_error?: number|string;
-  validation_error?: number|string;
+  validation_error: number|string;
   error?: number|string;
 }
 export interface ResultInfo<T> {
@@ -16,7 +16,7 @@ export interface ResultInfo<T> {
   value?: T;
   message?: string;
 }
-export function initializeStatus(s: StatusConfig): StatusConfig {
+export function initializeStatus(s?: StatusConfig): StatusConfig {
   if (s) {
     return s;
   }
@@ -25,86 +25,118 @@ export function initializeStatus(s: StatusConfig): StatusConfig {
     not_found: 0,
     success: 1,
     version_error: 2,
+    validation_error: 4,
     error: 4
   };
   return s1;
 }
-export function checkId<T, ID>(obj: T, id: ID, keys: Attribute[]): boolean {
-  let n = 'id';
-  if (keys && keys.length === 1) {
-    n = keys[0].name;
-  }
+*/
+export function checkId<T, ID>(obj: T, id: ID, keys?: Attribute[]): boolean {
+  const n: string = keys && keys.length === 1 && keys[0].name ? keys[0].name : "id"
+  const o: any = obj
+  const i: any = id
   if (!keys || keys.length === 1) {
-    const v = obj[n];
+    const v = o[n]
     if (!v) {
-      obj[n] = id;
-      return true;
+      o[n] = i
+      return true
     }
     // tslint:disable-next-line:triple-equals
-    if (v != id) {
-      return false;
+    if (v != i) {
+      return false
     }
-    return true;
+    return true
   }
-  const ks = Object.keys(id);
+  const ks = Object.keys(i)
   for (const k of ks) {
-    const v = obj[k];
+    const v = o[k]
     if (!v) {
-      obj[k] = id[k];
+      o[k] = i[k]
     } else {
       // tslint:disable-next-line:triple-equals
-      if (v != id[k]) {
-        return false;
+      if (v != i[k]) {
+        return false
       }
     }
-    obj[k] = id[k];
+    o[k] = i[k]
   }
-  return true;
+  return true
 }
-export function create<T>(res: Response, status: StatusConfig, obj: T, insert: (obj: T, ctx?: any) => Promise<number|ResultInfo<T>>, log: (msg: string, ctx?: any) => void): void {
-  insert(obj).then(result => {
-    if (typeof result === 'number') {
-      if (result >= 1) {
-        const r: ResultInfo<T> = {status: status.success, value: obj};
-        res.status(201).json(r);
-      } else if (result === 0) {
-        const r: ResultInfo<T> = {status: status.duplicate_key};
-        res.status(201).json(r);
+export function create<T>(res: Response, obj: T, insert: (obj: T, ctx?: any) => Promise<number | T | ErrorMessage[]>, returnNumber?: boolean): void {
+  insert(obj)
+    .then((result) => {
+      if (typeof result === "number") {
+        if (result >= 1) {
+          res
+            .status(201)
+            .json(returnNumber ? result : obj)
+            .end()
+        } else {
+          res.status(409).json(result).end()
+        }
+      } else if (Array.isArray(result)) {
+        res.status(422).json(result).end()
       } else {
-        res.status(500).end('Internal Server Error');
+        res
+          .status(201)
+          .json(returnNumber ? result : obj)
+          .end()
       }
-    } else {
-      res.status(200).json(result);
-    }
-  }).catch(err => handleError(err, res, log));
+    })
+    .catch((err) => handleError(err, res))
 }
-export function update<T>(res: Response, status: StatusConfig, obj: T, save: (obj: T, ctx?: any) => Promise<number|ResultInfo<T>>, log: (msg: string, ctx?: any) => void): void {
-  save(obj).then(result => {
-    if (typeof result === 'number') {
-      if (result >= 1) {
-        const r: ResultInfo<T> = {status: status.success, value: obj};
-        res.status(201).json(r);
-      } else if (result === 0) {
-        const r: ResultInfo<T> = {status: status.not_found};
-        res.status(404).json(r);
+export function update<T>(res: Response, obj: T, save: (obj: T, ctx?: any) => Promise<number | T | ErrorMessage[]>, returnNumber?: boolean): void {
+  save(obj)
+    .then((result) => {
+      if (typeof result === "number") {
+        if (result >= 1) {
+          res
+            .status(200)
+            .json(returnNumber ? result : obj)
+            .end()
+        } else if (result === 0) {
+          res.status(404).json(result).end()
+        } else {
+          res.status(409).json(result).end()
+        }
+      } else if (Array.isArray(result)) {
+        res.status(422).json(result).end()
       } else {
-        const r: ResultInfo<T> = {status: status.not_found};
-        res.status(409).json(r);
+        res
+          .status(200)
+          .json(returnNumber ? result : obj)
+          .end()
       }
-    } else {
-      res.status(200).json(result);
-    }
-  }).catch(err => handleError(err, res, log));
+    })
+    .catch((err) => handleError(err, res))
 }
 export function isTypeError(errs: ErrorMessage[]): boolean {
   if (!errs) {
-    return false;
+    return false
   }
   for (const err of errs) {
-    const c = err.code;
-    if (c === 'string' || c === 'number' || c === 'date' || c === 'boolean') {
-      return true;
+    const c = err.code
+    if (
+      c === "type" ||
+      c === "string" ||
+      c === "number" ||
+      c === "date" ||
+      c === "boolean" ||
+      c === "strings" ||
+      c === "numbers" ||
+      c === "integers" ||
+      c === "dates" ||
+      c === "datetimes" ||
+      c === "booleans"
+    ) {
+      return true
     }
   }
-  return false;
+  return false
+}
+export function getStatusCode(errs: ErrorMessage[]): number {
+  return isTypeError(errs) ? 400 : 422
+}
+export function respondError(res: Response, errors: ErrorMessage[]) {
+  res.status(getStatusCode(errors)).json(errors).end()
 }

package/src/health.ts

@@ -1,51 +1,50 @@
-export type HealthStatus = 'UP' | 'DOWN';
+export type HealthStatus = "UP" | "DOWN"
 export interface HealthMap {
-  [key: string]: Health;
+  [key: string]: Health
 }
 export interface Health {
-  status: HealthStatus;
-  data?: AnyMap;
-  details?: HealthMap;
+  status: HealthStatus
+  data?: AnyMap
+  details?: HealthMap
 }
 export interface AnyMap {
-  [key: string]: any;
+  [key: string]: any
 }
 export interface HealthChecker {
-  name(): string;
-  build(data: AnyMap, error: any): AnyMap;
-  check(): Promise<AnyMap>;
+  name(): string
+  build(data: AnyMap, error: any): AnyMap
+  check(): Promise<AnyMap>
 }
 
-export async function check(checkers: HealthChecker[]): Promise<Health> {
-  const p: Health = {
-    status: 'UP',
-    details: {} as HealthMap,
-  };
-  const total = checkers.length - 1;
-  let count = 0;
+export async function health(checkers: HealthChecker[]): Promise<Health> {
+  const p: Health = { status: "UP" }
+  const total = checkers.length - 1
+  let count = 0
+  p.details = {} as HealthMap
   for (const checker of checkers) {
-    const sub: Health = {status: 'UP'};
+    const sub: Health = { status: "UP" }
     try {
-      const r = await checker.check();
+      const r = await checker.check()
       if (r && Object.keys(r).length > 0) {
-        sub.data = r;
+        sub.data = r
       }
-      p.details[checker.name()] = sub;
+      p.details[checker.name()] = sub
       if (count >= total) {
-        return p;
+        return p
       } else {
-        count++;
+        count++
       }
     } catch (err) {
-      sub.status = 'DOWN';
-      p.status = 'DOWN';
-      sub.data = checker.build({} as AnyMap, err);
-      p.details[checker.name()] = sub;
+      sub.status = "DOWN"
+      p.status = "DOWN"
+      sub.data = checker.build({} as AnyMap, err)
+      p.details[checker.name()] = sub
       if (count >= total) {
-        return p;
+        return p
       } else {
-        count++;
+        count++
       }
     }
   }
+  return p
 }

package/src/http.ts

@@ -0,0 +1,295 @@
+import { Request, Response } from "express"
+import { Attribute } from "./metadata"
+import { resources } from "./resources"
+
+export type Log = (msg: string) => void
+export type LogFunc = Log
+
+Object.defineProperty(Error.prototype, "toJSON", {
+  value() {
+    const alt: any = {}
+    Object.getOwnPropertyNames(this).forEach(function (key) {
+      // @ts-ignore
+      alt[key] = this[key]
+    }, this)
+
+    return alt
+  },
+  configurable: true,
+  writable: true,
+})
+export function handleError(err: any, res: Response) {
+  if (resources.log) {
+    resources.log(toString(err))
+    res.status(500).end("Internal Server Error")
+  } else {
+    if (resources.returnServerError) {
+      res.status(500).end(toString(err))
+    } else {
+      console.error(toString(err))
+      res.status(500).end("Internal Server Error")
+    }
+  }
+}
+export const error = handleError
+export function toString(v: any): string {
+  if (typeof v === "string") {
+    return v
+  } else {
+    return JSON.stringify(v)
+  }
+}
+export function attr(name: string): Attribute {
+  return { name, type: "string" }
+}
+export function attrs(keys: string[]): Attribute[] {
+  const atts: Attribute[] = []
+  for (const str of keys) {
+    const at: Attribute = { name: str as string, type: "string" }
+    atts.push(at)
+  }
+  return atts
+}
+export function respondModel<T>(obj: T, res: Response): void {
+  if (obj) {
+    res.status(200).json(obj).end()
+  } else {
+    res.status(404).json(null).end()
+  }
+}
+export function queryRequiredParams(req: Request, res: Response, name: string, split?: string): string[] | undefined {
+  const v = req.query[name]
+  if (!v) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  }
+  const v2 = v.toString()
+  if (v2.length === 0) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  }
+  if (!split) {
+    split = ","
+  }
+  return v2.split(split)
+}
+export function queryParams(req: Request, name: string, d?: string[], split?: string): string[] | undefined {
+  const q = req.query[name]
+  if (!q) {
+    return d
+  }
+  const v = q.toString()
+  if (!v || v.length === 0) {
+    return d
+  }
+  if (!split) {
+    split = ","
+  }
+  return v.split(split)
+}
+export function queryParam(req: Request, res: Response, name: string): string | undefined {
+  const v = req.query[name]
+  if (!v) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  } else {
+    const v1 = v.toString()
+    if (v1.length === 0) {
+      res.status(400).end(`'${name}' cannot be empty`)
+      return undefined
+    } else {
+      return v1
+    }
+  }
+}
+export function query(req: Request, name: string, d?: string): string | undefined {
+  const p = req.query[name]
+  if (!p || p.toString().length === 0) {
+    return d
+  }
+  return p.toString()
+}
+export function queryRequiredNumber(req: Request, res: Response, name: string): number | undefined {
+  const field = req.query[name]
+  if (!field) {
+    return undefined
+  }
+  const v = field.toString()
+  if (!v || v.length === 0) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  }
+  if (isNaN(v as any)) {
+    res.status(400).end(`'${name}' is not a valid number`)
+    return undefined
+  }
+  const n = parseFloat(v as string)
+  return n
+}
+export function queryNumber(req: Request, name: string, d: number): number {
+  const field = req.query[name]
+  const v = field ? field.toString() : undefined
+  if (!v || v.length === 0) {
+    return d
+  }
+  if (isNaN(v as any)) {
+    return d
+  }
+  const n = parseFloat(v as string)
+  return n
+}
+export function queryRequiredDate(req: Request, res: Response, name: string): Date | undefined {
+  const field = req.query[name]
+  if (!field) {
+    return undefined
+  }
+  const v = field.toString()
+  if (!v || v.length === 0) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  }
+  const date = new Date(v as string)
+  if (date.toString() === "Invalid Date") {
+    res.status(400).end(`'${name}' is not a valid date`)
+    return undefined
+  }
+  return date
+}
+export function queryDate(req: Request, name: string, d?: Date): Date | undefined {
+  const field = req.query[name]
+  if (field) {
+    const v = field.toString()
+    if (!v || v.length === 0) {
+      return d
+    }
+    const date = new Date(v as string)
+    if (date.toString() === "Invalid Date") {
+      return d
+    }
+    return date
+  }
+  return undefined
+}
+export function param(req: Request, res: Response, name: string): string | undefined {
+  const v = req.params[name]
+  if (!v || v.length === 0) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  }
+  return v as string
+}
+export const getParam = param
+export function params(req: Request, name: string, d?: string[], split?: string): string[] | undefined {
+  const v = req.params[name] as string
+  if (!v || v.length === 0) {
+    return d
+  }
+  if (!split) {
+    split = ","
+  }
+  return v.split(split)
+}
+export const getParams = params
+export function getRequiredParameters(req: Request, res: Response, name: string, split?: string): string[] | undefined {
+  const v = req.params[name] as string
+  if (!v || v.length === 0) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  }
+  if (!split) {
+    split = ","
+  }
+  return v.split(split)
+}
+export function getRequiredNumber(req: Request, res: Response, name: string): number | undefined {
+  const v = req.params[name]
+  if (!v || v.length === 0) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  }
+  if (isNaN(v as any)) {
+    res.status(400).end(`'${name}' must be a number`)
+    return undefined
+  }
+  const n = parseFloat(v as string)
+  return n
+}
+export function getNumber(req: Request, name: string, d?: number): number | undefined {
+  const v = req.params[name]
+  if (!v || v.length === 0) {
+    return d
+  }
+  if (isNaN(v as any)) {
+    return d
+  }
+  const n = parseFloat(v as string)
+  return n
+}
+export function getInteger(req: Request, name: string, d?: number): number | undefined {
+  const v = req.params[name]
+  if (!v || v.length === 0) {
+    return d
+  }
+  if (isNaN(v as any)) {
+    return d
+  }
+  const n = parseFloat(v as string)
+  const s = n.toFixed(0)
+  return parseFloat(s)
+}
+export function getRequiredDate(req: Request, res: Response, name: string): Date | undefined {
+  const v = req.params[name]
+  if (!v || v.length === 0) {
+    res.status(400).end(`'${name}' cannot be empty`)
+    return undefined
+  }
+  const date = new Date(v as string)
+  if (date.toString() === "Invalid Date") {
+    res.status(400).end(`'${name}' must be a date`)
+    return undefined
+  }
+  return date
+}
+export function getDate(req: Request, name: string, d?: Date): Date | undefined {
+  const v = req.params[name]
+  if (!v || v.length === 0) {
+    return d
+  }
+  const date = new Date(v as string)
+  if (date.toString() === "Invalid Date") {
+    return d
+  }
+  return date
+}
+const o = "object"
+export function minimize(obj: any): any {
+  if (!obj || typeof obj !== o) {
+    return obj
+  }
+  const keys = Object.keys(obj)
+  for (const key of keys) {
+    const v = obj[key]
+    if (v == null) {
+      delete obj[key]
+    } else if (Array.isArray(v) && v.length > 0) {
+      const v1 = v[0]
+      if (typeof v1 === o && !(v1 instanceof Date)) {
+        for (const item of v) {
+          minimize(item)
+        }
+      }
+    }
+  }
+  return obj
+}
+export function minimizeArray<T>(arrs: T[]): T[] {
+  if (!arrs) {
+    return arrs
+  }
+  if (arrs.length > 0) {
+    for (const obj of arrs) {
+      minimize(obj)
+    }
+  }
+  return arrs
+}