express-ext 0.2.5 → 0.2.7

package/lib/resources.js

@@ -1,14 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var fs = require("fs");
-var http = require("http");
-var https = require("https");
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+var fs = require('fs');
+var http = require('http');
+var https = require('https');
 var resources = (function () {
-  function resources() {
-  }
+  function resources() {}
+  resources.pageSizes = [12, 24, 60, 100, 120, 180, 300, 600];
+  resources.page = 'page';
+  resources.limit = 'limit';
+  resources.defaultLimit = 12;
+  resources.sort = 'sort';
+  resources.partial = 'partial';
   resources.encoding = 'utf-8';
   return resources;
-}());
+})();
 exports.resources = resources;
 var TypeChecker = (function () {
   function TypeChecker(attributes, allowUndefined) {
@@ -20,19 +25,17 @@ var TypeChecker = (function () {
     var obj = req.body;
     if (!obj || obj === '') {
       res.status(400).end('The request body cannot be empty');
-    }
-    else {
+    } else {
       var errors = resources.check(obj, this.attributes, this.allowUndefined);
       if (errors.length > 0) {
         res.status(400).json(errors).end();
-      }
-      else {
+      } else {
         next();
       }
     }
   };
   return TypeChecker;
-}());
+})();
 exports.TypeChecker = TypeChecker;
 function check(attributes, allowUndefined) {
   var x = new TypeChecker(attributes, allowUndefined);
@@ -64,23 +67,20 @@ function start(a, s) {
       https.createServer(s.options, a).listen(s.port, function () {
         console.log('Use https and start server at port ' + s.port);
       });
-    }
-    else if (s.key && s.cert && s.key.length > 0 && s.cert.length > 0) {
+    } else if (s.key && s.cert && s.key.length > 0 && s.cert.length > 0) {
       var options = {
         key: fs.readFileSync(s.key),
-        cert: fs.readFileSync(s.cert)
+        cert: fs.readFileSync(s.cert),
       };
       https.createServer(options, a).listen(s.port, function () {
         console.log('Use https and start server at port ' + s.port);
       });
-    }
-    else {
+    } else {
       http.createServer(a).listen(s.port, function () {
         console.log('Start server at port ' + s.port);
       });
     }
-  }
-  else {
+  } else {
     http.createServer(a).listen(s.port, function () {
       console.log('Start server at port ' + s.port);
     });

package/lib/search.js

@@ -1,6 +1,8 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
 var http_1 = require('./http');
+var resources_1 = require('./resources');
+var et = '';
 function getOffset(limit, page) {
   var offset = limit * (page - 1);
   return offset < 0 ? 0 : offset;
@@ -32,68 +34,167 @@ function buildPages(pageSize, total) {
   return arr;
 }
 exports.buildPages = buildPages;
-function getPageQuery(query, page) {
-  var s = page && page.length > 0 ? page : 'page';
-  var i = query.indexOf(s + '=');
+function hasSearch(req) {
+  return req.url.indexOf('?') >= 0;
+}
+exports.hasSearch = hasSearch;
+function getSearch(url) {
+  var i = url.indexOf('?');
+  return i < 0 ? et : url.substring(i + 1);
+}
+exports.getSearch = getSearch;
+function getField(search, fieldName) {
+  var i = search.indexOf(fieldName + '=');
   if (i < 0) {
     return '';
   }
-  var j = query.indexOf('&', i + s.length);
-  return j < 0 ? query.substring(i) : query.substring(i, j);
+  if (i > 0) {
+    if (search.substring(i - 1, 1) != '&') {
+      i = search.indexOf('&' + fieldName + '=');
+      if (i < 0) {
+        return search;
+      }
+      i = i + 1;
+    }
+  }
+  var j = search.indexOf('&', i + fieldName.length);
+  return j >= 0 ? search.substring(i, j) : search.substring(i);
 }
-exports.getPageQuery = getPageQuery;
-var PartialTrue = 'partial=true';
-function removePageQuery(query, page, partialIsTrue) {
-  if (query.length == 0) {
-    return query;
+exports.getField = getField;
+function removeField(search, fieldName) {
+  var i = search.indexOf(fieldName + '=');
+  if (i < 0) {
+    return search;
   }
-  var partialTrue = partialIsTrue && partialIsTrue.length > 0 ? partialIsTrue : PartialTrue;
-  var p1 = '&' + partialTrue;
-  var q1 = query.indexOf(p1);
-  if (q1 >= 0) {
-    query = query.substring(0, q1) + query.substring(q1 + partialTrue.length + 2);
-  } else {
-    var p2 = partialTrue + '&';
-    var q2 = query.indexOf(p2);
-    if (q2 >= 0) {
-      query = query.substring(0, q1) + query.substring(q1 + partialTrue.length + 2);
+  if (i > 0) {
+    if (search.substring(i - 1, 1) != '&') {
+      i = search.indexOf('&' + fieldName + '=');
+      if (i < 0) {
+        return search;
+      }
+      i = i + 1;
     }
   }
-  var pageQuery = getPageQuery(query, page);
-  if (pageQuery.length == 0) {
-    return query;
+  var j = search.indexOf('&', i + fieldName.length);
+  return j >= 0 ? search.substring(0, i) + search.substring(j + 1) : search.substring(0, i - 1);
+}
+exports.removeField = removeField;
+function removePage(search) {
+  search = removeField(search, resources_1.resources.page);
+  search = removeField(search, resources_1.resources.partial);
+  return search;
+}
+exports.removePage = removePage;
+function buildPageSearch(search) {
+  var sr = removePage(search);
+  return sr.length == 0 ? sr : '&' + sr;
+}
+exports.buildPageSearch = buildPageSearch;
+function buildPageSearchFromUrl(url) {
+  var search = getSearch(url);
+  return buildPageSearch(search);
+}
+exports.buildPageSearchFromUrl = buildPageSearchFromUrl;
+function removeSort(search) {
+  search = removeField(search, resources_1.resources.sort);
+  search = removeField(search, resources_1.resources.partial);
+  return search;
+}
+exports.removeSort = removeSort;
+function getSortString(field, sort) {
+  if (field === sort.field) {
+    return sort.type === '-' ? field : '-' + field;
+  }
+  return field;
+}
+exports.getSortString = getSortString;
+function buildSort(s) {
+  if (!s || s.indexOf(',') >= 0) {
+    return {};
+  }
+  if (s.startsWith('-')) {
+    return { field: s.substring(1), type: '-' };
   } else {
-    var x = pageQuery + '&';
-    if (query.indexOf(x) >= 0) {
-      return query.replace(x, '');
-    }
-    var x2 = '&' + pageQuery;
-    if (query.indexOf(x2) >= 0) {
-      return query.replace(x2, '');
-    }
-    return query.replace(pageQuery, '');
+    return { field: s.startsWith('+') ? s.substring(1) : s, type: '+' };
   }
 }
-exports.removePageQuery = removePageQuery;
-function hasQuery(req) {
-  return req.url.indexOf('?') >= 0;
+exports.buildSort = buildSort;
+function buildSortFromRequest(req) {
+  var s = http_1.query(req, resources_1.resources.sort);
+  return buildSort(s);
 }
-exports.hasQuery = hasQuery;
-function getQuery(url) {
-  var i = url.indexOf('?');
-  return i < 0 ? '' : url.substring(i + 1);
+exports.buildSortFromRequest = buildSortFromRequest;
+function renderSort(field, sort) {
+  if (field === sort.field) {
+    return sort.type === '-' ? "<i class='sort-down'></i>" : "<i class='sort-up'></i>";
+  }
+  return et;
 }
-exports.getQuery = getQuery;
-function buildPageQuery(query) {
-  var qr = removePageQuery(query);
-  return qr.length == 0 ? qr : '&' + qr;
+exports.renderSort = renderSort;
+function buildSortSearch(search, fields, sort) {
+  search = removeSort(search);
+  var sorts = {};
+  var prefix = search.length > 0 ? '?' + search + '&' : '?';
+  for (var i = 0; i < fields.length; i++) {
+    sorts[fields[i]] = {
+      url: prefix + resources_1.resources.sort + '=' + getSortString(fields[i], sort),
+      tag: renderSort(fields[i], sort),
+    };
+  }
+  return sorts;
 }
-exports.buildPageQuery = buildPageQuery;
-function buildPageQueryFromUrl(url) {
-  var query = getQuery(url);
-  return buildPageQuery(query);
+exports.buildSortSearch = buildSortSearch;
+function clone(obj) {
+  if (!obj) {
+    return obj;
+  }
+  if (obj instanceof Date) {
+    return new Date(obj.getTime());
+  }
+  if (typeof obj !== 'object') {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    var arr = [];
+    for (var _i = 0, obj_1 = obj; _i < obj_1.length; _i++) {
+      var sub = obj_1[_i];
+      var c = clone(sub);
+      arr.push(c);
+    }
+    return arr;
+  }
+  var x = {};
+  var keys = Object.keys(obj);
+  for (var _a = 0, keys_1 = keys; _a < keys_1.length; _a++) {
+    var k = keys_1[_a];
+    var v = obj[k];
+    if (v instanceof Date) {
+      x[k] = new Date(v.getTime());
+    } else {
+      switch (typeof v) {
+        case 'object':
+          x[k] = clone(v);
+          break;
+        default:
+          x[k] = v;
+          break;
+      }
+    }
+  }
+  return x;
+}
+exports.clone = clone;
+function cloneFilter(obj, page, limit) {
+  var f = clone(obj);
+  if (!obj.hasOwnProperty(resources_1.resources.page)) {
+    obj[resources_1.resources.page] = page;
+  }
+  if (!obj.hasOwnProperty(resources_1.resources.limit)) {
+    obj[resources_1.resources.limit] = limit;
+  }
+  return f;
 }
-exports.buildPageQueryFromUrl = buildPageQueryFromUrl;
+exports.cloneFilter = cloneFilter;
 function jsonResult(res, result, quick, fields, config) {
   if (quick && fields && fields.length > 0) {
     res.status(200).json(toCsv(fields, result)).end();
@@ -205,8 +306,8 @@ function fromUrl(req, arr) {
   var s = {};
   var obj = req.query;
   var keys = Object.keys(obj);
-  for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
-    var key = keys_1[_i];
+  for (var _i = 0, keys_2 = keys; _i < keys_2.length; _i++) {
+    var key = keys_2[_i];
     if (inArray(key, arr)) {
       var x = obj[key].split(',');
       setValue(s, key, x);
@@ -495,8 +596,8 @@ function buildMetadata(attributes, includeDate) {
   var keys = Object.keys(attributes);
   var dates = [];
   var numbers = [];
-  for (var _i = 0, keys_2 = keys; _i < keys_2.length; _i++) {
-    var key = keys_2[_i];
+  for (var _i = 0, keys_3 = keys; _i < keys_3.length; _i++) {
+    var key = keys_3[_i];
     var attr = attributes[key];
     if (attr.type === 'number' || attr.type === 'integer') {
       numbers.push(key);
@@ -564,8 +665,8 @@ function format(obj, dates, nums) {
           }
         } else if (typeof v === 'object') {
           var keys = Object.keys(v);
-          for (var _a = 0, keys_3 = keys; _a < keys_3.length; _a++) {
-            var key = keys_3[_a];
+          for (var _a = 0, keys_4 = keys; _a < keys_4.length; _a++) {
+            var key = keys_4[_a];
             var v2 = v[key];
             if (v2 instanceof Date) {
               continue;
@@ -607,8 +708,8 @@ function format(obj, dates, nums) {
           }
         } else if (typeof v === 'object') {
           var keys = Object.keys(v);
-          for (var _c = 0, keys_4 = keys; _c < keys_4.length; _c++) {
-            var key = keys_4[_c];
+          for (var _c = 0, keys_5 = keys; _c < keys_5.length; _c++) {
+            var key = keys_5[_c];
             var v2 = v[key];
             if (v2 instanceof Date) {
               delete o[key];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-ext",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "express-ext",
   "main": "./lib/index.js",
   "types": "./src/index.ts",
@@ -25,7 +25,11 @@
   },
   "keywords": [
     "express",
+    "express-plus",
+    "express plus",
     "express-ext",
-    "express-plus"
+    "express ext",
+    "express-extension",
+    "express extension"
   ]
 }

package/src/resources.ts

@@ -4,15 +4,24 @@ import * as http from 'http';
 import * as https from 'https';
 import { Attributes, ErrorMessage } from './metadata';
 
+export interface StringMap {
+  [key: string]: string;
+}
 // tslint:disable-next-line:class-name
 export class resources {
+  static pageSizes = [12, 24, 60, 100, 120, 180, 300, 600];
+  static page = 'page';
+  static limit = 'limit';
+  static defaultLimit = 12;
+  static sort = 'sort';
+  static partial = 'partial';
   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[]>;
+  validate(obj: T, patch?: boolean, resource?: StringMap): Promise<ErrorMessage[]>;
 }
 
 // tslint:disable-next-line:max-classes-per-file
@@ -64,7 +73,12 @@ export interface TemplateNode {
   suffix?: string | null;
   prefix?: 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 {
+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;
   }
@@ -97,7 +111,7 @@ export function start(a: Application, s: Server): void {
     } else if (s.key && s.cert && s.key.length > 0 && s.cert.length > 0) {
       const options = {
         key: fs.readFileSync(s.key),
-        cert: fs.readFileSync(s.cert)
+        cert: fs.readFileSync(s.cert),
       };
       https.createServer(options, a).listen(s.port, () => {
         console.log('Use https and start server at port ' + s.port);

package/src/search.ts

@@ -1,8 +1,14 @@
 import { Request, Response } from 'express';
-import { minimizeArray } from './http';
+import { minimizeArray, query } from './http';
 import { Attribute, Attributes } from './metadata';
+import { resources } from './resources';
+
+const et = '';
 
 export interface Filter {
+  page?: number;
+  limit?: number;
+
   fields?: string[];
   sort?: string;
 
@@ -58,61 +64,161 @@ export function buildPages(pageSize?: number, total?: number): number[] {
   }
   return arr;
 }
-export function getPageQuery(query: string, page?: string): string {
-  const s = page && page.length > 0 ? page : 'page';
-  const i = query.indexOf(s + '=');
+
+export function hasSearch(req: Request): boolean {
+  return req.url.indexOf('?') >= 0;
+}
+export function getSearch(url: string): string {
+  const i = url.indexOf('?');
+  return i < 0 ? et : url.substring(i + 1);
+}
+export function getField(search: string, fieldName: string): string {
+  let i = search.indexOf(fieldName + '=');
   if (i < 0) {
     return '';
   }
-  const j = query.indexOf('&', i + s.length);
-  return j < 0 ? query.substring(i) : query.substring(i, j);
+  if (i > 0) {
+    if (search.substring(i - 1, 1) != '&') {
+      i = search.indexOf('&' + fieldName + '=');
+      if (i < 0) {
+        return search;
+      }
+      i = i + 1;
+    }
+  }
+  const j = search.indexOf('&', i + fieldName.length);
+  return j >= 0 ? search.substring(i, j) : search.substring(i);
 }
-const PartialTrue = 'partial=true';
-export function removePageQuery(query: string, page?: string, partialIsTrue?: string): string {
-  if (query.length == 0) {
-    return query;
+export function removeField(search: string, fieldName: string): string {
+  let i = search.indexOf(fieldName + '=');
+  if (i < 0) {
+    return search;
   }
-  const partialTrue = partialIsTrue && partialIsTrue.length > 0 ? partialIsTrue : PartialTrue;
-  const p1 = '&' + partialTrue;
-  const q1 = query.indexOf(p1);
-  if (q1 >= 0) {
-    query = query.substring(0, q1) + query.substring(q1 + partialTrue.length + 2);
-  } else {
-    const p2 = partialTrue + '&';
-    const q2 = query.indexOf(p2);
-    if (q2 >= 0) {
-      query = query.substring(0, q1) + query.substring(q1 + partialTrue.length + 2);
+  if (i > 0) {
+    if (search.substring(i - 1, 1) != '&') {
+      i = search.indexOf('&' + fieldName + '=');
+      if (i < 0) {
+        return search;
+      }
+      i = i + 1;
     }
   }
-  const pageQuery = getPageQuery(query, page);
-  if (pageQuery.length == 0) {
-    return query;
+  const j = search.indexOf('&', i + fieldName.length);
+  return j >= 0 ? search.substring(0, i) + search.substring(j + 1) : search.substring(0, i - 1);
+}
+export function removePage(search: string): string {
+  search = removeField(search, resources.page);
+  search = removeField(search, resources.partial);
+  return search;
+}
+export function buildPageSearch(search: string): string {
+  const sr = removePage(search);
+  return sr.length == 0 ? sr : '&' + sr;
+}
+export function buildPageSearchFromUrl(url: string): string {
+  const search = getSearch(url);
+  return buildPageSearch(search);
+}
+export function removeSort(search: string): string {
+  search = removeField(search, resources.sort);
+  search = removeField(search, resources.partial);
+  return search;
+}
+export interface Sort {
+  field?: string;
+  type?: string;
+}
+export interface SortType {
+  url: string;
+  tag: string;
+}
+export interface SortMap {
+  [key: string]: SortType;
+}
+export function getSortString(field: string, sort: Sort): string {
+  if (field === sort.field) {
+    return sort.type === '-' ? field : '-' + field;
+  }
+  return field;
+}
+export function buildSort(s?: string): Sort {
+  if (!s || s.indexOf(',') >= 0) {
+    return {} as Sort;
+  }
+  if (s.startsWith('-')) {
+    return { field: s.substring(1), type: '-' };
   } else {
-    const x = pageQuery + '&';
-    if (query.indexOf(x) >= 0) {
-      return query.replace(x, '');
-    }
-    const x2 = '&' + pageQuery;
-    if (query.indexOf(x2) >= 0) {
-      return query.replace(x2, '');
-    }
-    return query.replace(pageQuery, '');
+    return { field: s.startsWith('+') ? s.substring(1) : s, type: '+' };
   }
 }
-export function hasQuery(req: Request): boolean {
-  return req.url.indexOf('?') >= 0;
+export function buildSortFromRequest(req: Request): Sort {
+  const s = query(req, resources.sort);
+  return buildSort(s);
 }
-export function getQuery(url: string): string {
-  const i = url.indexOf('?');
-  return i < 0 ? '' : url.substring(i + 1);
+export function renderSort(field: string, sort: Sort): string {
+  if (field === sort.field) {
+    return sort.type === '-' ? "<i class='sort-down'></i>" : "<i class='sort-up'></i>";
+  }
+  return et;
+}
+export function buildSortSearch(search: string, fields: string[], sort: Sort): SortMap {
+  search = removeSort(search);
+  let sorts: SortMap = {};
+  const prefix = search.length > 0 ? '?' + search + '&' : '?';
+  for (let i = 0; i < fields.length; i++) {
+    sorts[fields[i]] = {
+      url: prefix + resources.sort + '=' + getSortString(fields[i], sort),
+      tag: renderSort(fields[i], sort),
+    };
+  }
+  return sorts;
 }
-export function buildPageQuery(query: string): string {
-  const qr = removePageQuery(query);
-  return qr.length == 0 ? qr : '&' + qr;
+export function clone(obj: any): any {
+  if (!obj) {
+    return obj;
+  }
+  if (obj instanceof Date) {
+    return new Date(obj.getTime());
+  }
+  if (typeof obj !== 'object') {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    const arr = [];
+    for (const sub of obj) {
+      const c = clone(sub);
+      arr.push(c);
+    }
+    return arr;
+  }
+  const x: any = {};
+  const keys = Object.keys(obj);
+  for (const k of keys) {
+    const v = obj[k];
+    if (v instanceof Date) {
+      x[k] = new Date(v.getTime());
+    } else {
+      switch (typeof v) {
+        case 'object':
+          x[k] = clone(v);
+          break;
+        default:
+          x[k] = v;
+          break;
+      }
+    }
+  }
+  return x;
 }
-export function buildPageQueryFromUrl(url: string): string {
-  const query = getQuery(url);
-  return buildPageQuery(query);
+export function cloneFilter<F extends Filter>(obj: F, page: number, limit: number): F {
+  const f = clone(obj);
+  if (!obj.hasOwnProperty(resources.page)) {
+    (obj as any)[resources.page] = page;
+  }
+  if (!obj.hasOwnProperty(resources.limit)) {
+    (obj as any)[resources.limit] = limit;
+  }
+  return f;
 }
 
 export function jsonResult<T>(res: Response, result: SearchResult<T>, quick?: boolean, fields?: string[], config?: SearchConfig): void {