express-ext 0.1.13 → 0.1.17

package/src/LoadController.ts

@@ -1,5 +1,5 @@
 import {Request, Response} from 'express';
-import {attrs, handleError, Log, respondModel} from './http';
+import {attrs, handleError, Log, minimize, respondModel} from './http';
 import {Attribute, Attributes} from './metadata';
 import {buildAndCheckId, buildKeys} from './view';
 
@@ -48,7 +48,7 @@ export class LoadController<T, ID> {
     const id = buildAndCheckId<ID>(req, res, this.keys);
     if (id) {
       this.view(id)
-        .then(obj => respondModel(obj, res))
+        .then(obj => respondModel(minimize(obj), res))
         .catch(err => handleError(err, res, this.log));
     }
   }

package/src/LoadSearchController.ts

@@ -2,7 +2,7 @@ import {Request, Response} from 'express';
 import {handleError, Log} from './http';
 import {LoadController, ViewService} from './LoadController';
 import {Attribute, Attributes} from './metadata';
-import {Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
+import {buildArray, Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
 import {getMetadataFunc} from './search_func';
 
 export class LoadSearchController<T, ID, S extends Filter> extends LoadController<T, ID> {
@@ -12,6 +12,7 @@ export class LoadSearchController<T, ID, S extends Filter> extends LoadControlle
   numbers?: string[];
   fields?: string;
   excluding?: string;
+  array?: string[];
   constructor(log: Log, public find: (s: S, limit?: number, skip?: number|string, fields?: string[]) => Promise<SearchResult<T>>, viewService: ViewService<T, ID> | ((id: ID, ctx?: any) => Promise<T>), keys?: Attributes|Attribute[]|string[], config?: SearchConfig|boolean, dates?: string[], numbers?: string[]) {
     super(log, viewService, keys);
     this.search = this.search.bind(this);
@@ -37,7 +38,7 @@ export class LoadSearchController<T, ID, S extends Filter> extends LoadControlle
     }
   }
   search(req: Request, res: Response) {
-    const s = fromRequest<S>(req, this.fields, this.excluding);
+    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);
     this.find(s2, l.limit, l.skipOrRefId, l.fields)

package/src/LogController.ts

@@ -1,11 +1,14 @@
-import {Request, Response} from 'express';
+import { Request, Response } from 'express';
+import { SimpleMap } from './log';
 
 export interface NumberMap {
   [key: string]: number;
 }
-export interface LogConf {
+export interface LogConfig {
   level?: string;
   map?: LogMapConfig;
+  constants?: SimpleMap;
+  name?: Name;
 }
 export interface LogMapConfig {
   time?: string;
@@ -17,54 +20,117 @@ export interface LogMap {
   level: string;
   msg: string;
 }
-export interface LoggerConf {
+export interface Name {
+  trace: string;
+  debug: string;
+  info: string;
+  warn: string;
+  error: string;
+  panic: string;
+  fatal: string;
+}
+export interface Logger {
+  name: Name;
   level: number;
   map: LogMap;
+  constants?: SimpleMap;
+  trace(msg: string, m?: SimpleMap, ctx?: any): void;
+  debug(msg: string, m?: SimpleMap, ctx?: any): void;
+  info(msg: string, m?: SimpleMap, ctx?: any): void;
+  warn(msg: string, m?: SimpleMap, ctx?: any): void;
+  error(msg: string, m?: SimpleMap, ctx?: any): void;
+  panic(msg: string, m?: SimpleMap, ctx?: any): void;
+  fatal(msg: string, m?: SimpleMap, ctx?: any): void;
+  isLevelEnabled(level: number): boolean;
+  isTraceEnabled(): boolean;
+  isDebugEnabled(): boolean;
+  isInfoEnabled(): boolean;
+  isWarnEnabled(): boolean;
+  isErrorEnabled(): boolean;
+  isPanicEnabled(): boolean;
+  isFatalEnabled(): boolean;
 }
-
+export const map: NumberMap = {
+  TRACE: -2,
+  DEBUG: -1,
+  INFO: 0,
+  WARN: 1,
+  ERROR: 2,
+  PANIC: 3,
+  FATAL: 4
+};
 export class LogController {
-  map?: NumberMap;
-  constructor(public logger: LoggerConf, mp?: NumberMap) {
-    this.map = mp;
+  map: NumberMap;
+  update: (logger: Logger, obj: LogConfig, mp: NumberMap) => boolean;
+  constructor(public logger: Logger, updateL?: (logger: Logger, obj: LogConfig, mp: NumberMap) => boolean, mp?: NumberMap) {
+    this.map = (mp ? mp : map);
+    this.update = updateL ? updateL : updateLog;
     this.config = this.config.bind(this);
   }
   config(req: Request, res: Response) {
-    const obj: LogConf = req.body;
+    const obj: LogConfig = req.body;
     if (!obj || obj === '') {
       return res.status(400).end('The request body cannot be empty');
     }
-    if (!this.logger || !this.map) {
+    if (!this.logger) {
       return res.status(503).end('Logger is not available');
     }
-    if (!this.map) {
-      return res.status(503).end('Map is not available');
-    }
-    let changed = false;
-    if (obj.level && typeof obj.level === 'string' && obj.level.length > 0) {
-      const lv = this.map[obj.level.toUpperCase()];
-      if (lv !== undefined) {
-        this.logger.level = lv;
-        changed = true;
-      }
-    }
-    if (obj.map) {
-      if (obj.map.level && typeof obj.map.level === 'string' && obj.map.level.length > 0) {
-        this.logger.map.level = obj.map.level;
-        changed = true;
-      }
-      if (obj.map.time && typeof obj.map.time === 'string' && obj.map.time.length > 0) {
-        this.logger.map.time = obj.map.time;
-        changed = true;
-      }
-      if (obj.map.msg && typeof obj.map.msg === 'string' && obj.map.msg.length > 0) {
-        this.logger.map.msg = obj.map.msg;
-        changed = true;
+    if (typeof obj.level === 'string' && obj.level.length > 0) {
+      if (!this.map) {
+        return res.status(503).end('Map is not available');
       }
     }
+    const changed = this.update(this.logger, obj, this.map);
     if (changed) {
-      return res.status(200).end('true');
+      return res.status(200).json(true).end();
     } else {
-      return res.status(204).end('false');
+      return res.status(204).json(false).end();
+    }
+  }
+}
+export function updateLog(logger: Logger, obj: LogConfig, mp: NumberMap): boolean {
+  let changed = false;
+  if (typeof obj.level === 'string' && obj.level.length > 0) {
+    const lv = mp[obj.level.toUpperCase()];
+    if (lv !== undefined) {
+      logger.level = lv;
+      changed = true;
+    }
+  }
+  if (obj.map) {
+    if (typeof obj.map.level === 'string' && obj.map.level.length > 0) {
+      logger.map.level = obj.map.level;
+      changed = true;
+    }
+    if (typeof obj.map.time === 'string' && obj.map.time.length > 0) {
+      logger.map.time = obj.map.time;
+      changed = true;
+    }
+    if (typeof obj.map.msg === 'string' && obj.map.msg.length > 0) {
+      logger.map.msg = obj.map.msg;
+      changed = true;
+    }
+  }
+  if (obj.constants !== undefined && typeof obj.constants === 'object') {
+    const ks = Object.keys(obj.constants);
+    if (ks.length > 0) {
+      logger.constants = obj.constants;
+    } else {
+      logger.constants = undefined;
+    }
+    changed = true;
+  }
+  if (obj.name) {
+    if (typeof obj.name.trace === 'string'
+      && typeof obj.name.debug === 'string'
+      && typeof obj.name.info === 'string'
+      && typeof obj.name.warn === 'string'
+      && typeof obj.name.error === 'string'
+      && typeof obj.name.panic === 'string'
+      && typeof obj.name.fatal === 'string') {
+      logger.name = obj.name;
+      changed = true;
     }
   }
+  return changed;
 }

package/src/LowCodeController.ts

@@ -3,7 +3,7 @@ import {ResultInfo, StatusConfig} from './edit';
 import {GenericController, GenericService} from './GenericController';
 import {handleError, Log} from './http';
 import {ErrorMessage} from './metadata';
-import {Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
+import {buildArray, Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
 import {getMetadataFunc} from './search_func';
 
 export interface LowCodeConfig extends StatusConfig, SearchConfig {
@@ -18,6 +18,7 @@ export class LowCodeController<T, ID, S extends Filter> extends GenericControlle
   numbers?: string[];
   fields?: string;
   excluding?: string;
+  array?: string[];
   constructor(log: Log, public lowCodeService: Service<T, ID, number|ResultInfo<T>, S>, config?: LowCodeConfig, validate?: (obj: T, patch?: boolean) => Promise<ErrorMessage[]>, dates?: string[], numbers?: string[]) {
     super(log, lowCodeService, config, validate);
     this.search = this.search.bind(this);
@@ -37,7 +38,7 @@ export class LowCodeController<T, ID, S extends Filter> extends GenericControlle
     }
   }
   search(req: Request, res: Response) {
-    const s = fromRequest<S>(req, this.fields, this.excluding);
+    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);
     this.lowCodeService.search(s2, l.limit, l.skipOrRefId, l.fields)

package/src/SearchController.ts

@@ -1,12 +1,13 @@
 import {Request, Response} from 'express';
 import {handleError, Log} from './http';
-import {Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
+import {buildArray, Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
 
 export class SearchController<T, S extends Filter> {
   config?: SearchConfig;
   csv?: boolean;
   fields?: string;
   excluding?: string;
+  array?: string[];
   constructor(protected log: Log, public find: (s: S, limit?: number, skip?: number|string, fields?: string[]) => Promise<SearchResult<T>>, config?: SearchConfig|boolean, public dates?: string[], public numbers?: string[]) {
     this.search = this.search.bind(this);
     if (config) {
@@ -26,7 +27,7 @@ export class SearchController<T, S extends Filter> {
     }
   }
   search(req: Request, res: Response) {
-    const s = fromRequest<S>(req, this.fields, this.excluding);
+    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);
     this.find(s2, l.limit, l.skipOrRefId, l.fields)

package/src/health.ts

@@ -16,7 +16,7 @@ export interface HealthChecker {
   check(): Promise<AnyMap>;
 }
 
-export async function check(checkers: HealthChecker[]): Promise<Health> {
+export async function health(checkers: HealthChecker[]): Promise<Health> {
   const p: Health = { status: 'UP' };
   const total = checkers.length - 1;
   let count = 0;

package/src/http.ts

@@ -239,3 +239,35 @@ export function getDate(req: Request, name: string, d?: Date): Date|undefined {
   }
   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;
+}

package/src/index.ts

@@ -1,3 +1,4 @@
+import {NextFunction, Request, Response} from 'express';
 import {GenericController} from './GenericController';
 import {GenericSearchController} from './GenericSearchController';
 import {HealthController} from './HealthController';
@@ -40,3 +41,20 @@ export * from './edit';
 export * from './GenericController';
 export * from './GenericSearchController';
 export * from './LowCodeController';
+
+export interface AccessConfig {
+  origin: string;
+  credentials: string;
+  methods: string;
+  headers: string;
+}
+export type AccessControlAllowConfig = AccessConfig;
+export function allow(access: AccessConfig): (req: Request, res: Response, next: NextFunction) => void {
+  return (req: Request, res: Response, next: NextFunction) => {
+    res.header('Access-Control-Allow-Origin', access.origin);
+    res.header('Access-Control-Allow-Credentials', access.credentials);
+    res.header('Access-Control-Allow-Methods', access.methods);
+    res.setHeader('Access-Control-Allow-Headers', access.headers);
+    next();
+  };
+}

package/src/log.ts

@@ -2,8 +2,9 @@ import { NextFunction } from 'express';
 import { ParamsDictionary, Request, Response } from 'express-serve-static-core';
 import { ParsedQs } from 'qs';
 import { PassThrough } from 'stream';
+import { resources } from './resources';
 
-export interface LogConfig {
+export interface LogConf {
   log?: boolean;
   separate?: boolean;
   skips?: string;
@@ -23,10 +24,10 @@ export interface MiddleLog {
   status: string;
   size: string;
 }
-interface SimpleMap {
+export interface SimpleMap {
   [key: string]: string|number|boolean|Date;
 }
-export function createConfig(c?: LogConfig): MiddleLog {
+export function createConfig(c?: LogConf): MiddleLog {
   if (!c) {
     return {skips: [], duration: 'duration', request: '', response: '', status: '', size: ''};
   }
@@ -58,24 +59,28 @@ export function removeUrlParams(url: string): string {
   const startParams = url.indexOf('?');
   return startParams !== -1 ? url.substring(0, startParams) : url;
 }
-export class Logger {
-  constructor(public write: (msg: string, m?: SimpleMap) => void, conf?: LogConfig, public build?: (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, m: SimpleMap) => SimpleMap) {
+export interface Middleware {
+  conf: MiddleLog;
+}
+const o = 'OPTIONS';
+export class MiddlewareLogger {
+  constructor(public write: (msg: string, m?: SimpleMap) => void, conf?: LogConf, public build?: (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, m: SimpleMap) => SimpleMap) {
     this.log = this.log.bind(this);
-    this.c = createConfig(conf);
+    this.conf = createConfig(conf);
   }
-  c: MiddleLog;
+  conf: MiddleLog;
   log(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>, number>, next: NextFunction) {
-    if (this.c.log && !skip(this.c.skips, req.originalUrl)) {
+    const m = req.method;
+    if (m !== o && this.conf.log && !skip(this.conf.skips, req.originalUrl)) {
       const start = process.hrtime();
-      const m = req.method;
-      const x = this.c.request;
+      const x = this.conf.request;
       let r = false;
       if (m !== 'GET' && m !== 'DELETE') {
         r = true;
       }
       const msg = `${m} ${req.originalUrl}`;
-      if (this.c.separate && r) {
-        if (this.c.request.length > 0) {
+      if (this.conf.separate && r) {
+        if (this.conf.request.length > 0) {
           const op: SimpleMap = {};
           op[x] = JSON.stringify(req.body);
           if (this.build) {
@@ -91,27 +96,27 @@ export class Logger {
       res.on('finish', () => {
           const duration = getDurationInMilliseconds(start);
           const op: SimpleMap = {};
-          op[this.c.duration] = duration;
-          if (r && !this.c.separate && this.c.request.length > 0) {
-            op[this.c.request] = JSON.stringify(req.body);
+          if (r && !this.conf.separate && this.conf.request.length > 0) {
+            op[x] = JSON.stringify(req.body);
           }
-          if (this.c.response.length > 0) {
-            const rsBody = Buffer.concat(chunks).toString();
-            op[this.c.response] = rsBody;
+          if (this.conf.response.length > 0) {
+            const rsBody = Buffer.concat(chunks).toString(resources.encoding);
+            op[this.conf.response] = rsBody;
           }
-          if (this.c.status.length > 0) {
-            op[this.c.status] = res.statusCode;
+          if (this.conf.status.length > 0) {
+            op[this.conf.status] = res.statusCode;
           }
-          if (this.c.size.length > 0) {
+          if (this.conf.size.length > 0) {
             if ('_contentLength' in res) {
-              op[this.c.size] = (res as any)['_contentLength'];
+              op[this.conf.size] = (res as any)['_contentLength'];
             } else if (res.hasHeader('content-length')) {
               const l = res.getHeader('content-length');
               if (typeof l === 'number' || typeof l === 'string') {
-                op[this.c.size] = l;
+                op[this.conf.size] = l;
               }
             }
           }
+          op[this.conf.duration] = duration;
           if (this.build) {
             const op2 = this.build(req, op);
             this.write(msg, op2);
@@ -148,3 +153,99 @@ const getDurationInMilliseconds = (start: [number, number] | undefined) => {
   const diff = process.hrtime(start);
   return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS;
 };
+
+// tslint:disable-next-line:max-classes-per-file
+export class MiddlewareController {
+  constructor(public logger: Middleware) {
+    this.config = this.config.bind(this);
+  }
+  config(req: Request, res: Response) {
+    const obj: MiddleLog = req.body;
+    if (!obj || (obj as any) === '') {
+      return res.status(400).end('The request body cannot be empty');
+    }
+    if (!this.logger) {
+      return res.status(503).end('Logger is not available');
+    }
+    let changed = false;
+    if (obj.log !== undefined) {
+      this.logger.conf.log = obj.log;
+      changed = true;
+    }
+    if (obj.separate !== undefined) {
+      this.logger.conf.separate = obj.separate;
+      changed = true;
+    }
+    if (Array.isArray(obj.skips)) {
+      if (isValidSkips(obj.skips)) {
+        this.logger.conf.skips = obj.skips;
+        changed = true;
+      }
+    }
+    if (typeof obj.duration === 'string' && obj.duration.length > 0) {
+      this.logger.conf.duration = obj.duration;
+      changed = true;
+    }
+    if (typeof obj.request === 'string') {
+      this.logger.conf.request = obj.request;
+      changed = true;
+    }
+    if (typeof obj.response === 'string') {
+      this.logger.conf.response = obj.response;
+      changed = true;
+    }
+    if (typeof obj.status === 'string') {
+      this.logger.conf.status = obj.status;
+      changed = true;
+    }
+    if (typeof obj.size === 'string') {
+      this.logger.conf.size = obj.size;
+      changed = true;
+    }
+    if (changed) {
+      return res.status(200).json(true).end();
+    } else {
+      return res.status(204).json(false).end();
+    }
+  }
+}
+export function isValidSkips(s: string[]): boolean {
+  for (const x of s) {
+    if (!(typeof x === 'string')) {
+      return false;
+    }
+  }
+  return true;
+}
+export function mask(s: string, start: number, end: number, replace: string): string {
+  if (start < 0) {
+    start = 0;
+  }
+  if (end < 0) {
+    end = 0;
+  }
+  const t = start + end;
+  if (t >= s.length) {
+    return replace.repeat(s.length);
+  }
+  return s.substr(0, start) + replace.repeat(s.length - t) + s.substr(s.length - end);
+}
+export function margin(s: string, start: number, end: number, replace: string): string {
+  if (start >= end) {
+    return '';
+  }
+  if (start < 0) {
+    start = 0;
+  }
+  if (end < 0) {
+    end = 0;
+  }
+  if (start >= s.length) {
+    return replace.repeat(s.length);
+  }
+  if (end >= s.length) {
+    return replace.repeat(start) + s.substr(start);
+  }
+  return replace.repeat(start) + s.substr(start, end - start) + replace.repeat(s.length - end);
+}
+export const maskMargin = margin;

package/src/metadata.ts

@@ -1,9 +1,11 @@
-export type DataType = 'ObjectId' | 'date' | 'datetime' | 'time'
+export type Type = 'ObjectId' | 'date' | 'datetime' | 'time'
     | 'boolean' | 'number' | 'integer' | 'string' | 'text'
     | 'object' | 'array' | 'binary'
     | 'primitives' | 'booleans' | 'numbers' | 'integers' | 'strings' | 'dates' | 'datetimes' | 'times';
-export type FormatType = 'currency' | 'percentage' | 'email' | 'url' | 'phone' | 'fax' | 'ipv4' | 'ipv6';
+export type Format = 'currency' | 'percentage' | 'email' | 'url' | 'phone' | 'fax' | 'ipv4' | 'ipv6';
 
+export type DataType = Type;
+export type FormatType = Format;
 export interface ErrorMessage {
   field: string;
   code: string;
@@ -17,8 +19,8 @@ export interface Model {
 
 export interface Attribute {
   name?: string;
-  type?: DataType;
-  format?: FormatType;
+  type?: Type;
+  format?: Format;
   required?: boolean;
   key?: boolean;
   length?: number;

package/src/resources.ts

@@ -1,10 +1,65 @@
-import {Attributes, ErrorMessage} from './metadata';
+import { NextFunction, Request, Response } from 'express';
+import * as fs from 'fs';
+import { Attributes, ErrorMessage } from './metadata';
 
 // tslint:disable-next-line:class-name
 export class resources {
   static createValidator?: <T>(attributes: Attributes, allowUndefined?: boolean, max?: number) => Validator<T>;
+  static check: (obj: any, attributes: Attributes, allowUndefined?: boolean, patch?: boolean) => ErrorMessage[];
+  static encoding?: BufferEncoding = 'utf-8';
 }
 
 export interface Validator<T> {
   validate(obj: T, patch?: boolean): Promise<ErrorMessage[]>;
 }
+
+// tslint:disable-next-line:max-classes-per-file
+export class TypeChecker {
+  constructor(public attributes: Attributes, public allowUndefined?: boolean) {
+    this.check = this.check.bind(this);
+  }
+  check(req: Request, res: Response, next: NextFunction): void {
+    const obj = req.body;
+    if (!obj || (obj as any) === '') {
+      return res.status(400).end('The request body cannot be empty');
+    } else {
+      const errors = resources.check(obj, this.attributes, this.allowUndefined);
+      if (errors.length > 0) {
+        res.status(400).json(errors).end();
+      } else {
+        next();
+      }
+    }
+  }
+}
+export type Handler = (req: Request, res: Response, next: NextFunction) => void;
+export function check(attributes: Attributes, allowUndefined?: boolean): Handler {
+  const x = new TypeChecker(attributes, allowUndefined);
+  return x.check;
+}
+export interface Template {
+  name?: string | null;
+  text: string;
+  templates: TemplateNode[];
+}
+export interface TemplateNode {
+  type: string;
+  text: string;
+  property: string | null;
+  encode?: string | null;
+  value: string | null;
+}
+export function loadTemplates(ok: boolean|undefined, buildTemplates: (streams: string[], correct?: (stream: string) => string) => Map<string, Template>, correct?: (stream: string) => string, files?: string[]): Map<string, Template>|undefined {
+  if (!ok) {
+    return undefined;
+  }
+  if (!files) {
+    files = ['./src/query.xml'];
+  }
+  const mappers: string[] = [];
+  for (const file of files) {
+    const mapper = fs.readFileSync(file, 'utf8');
+    mappers.push(mapper);
+  }
+  return buildTemplates(mappers, correct);
+}