express-ext 0.2.3 → 0.2.5

package/src/SearchController.ts

@@ -1,6 +1,6 @@
-import {Request, Response} from 'express';
-import {handleError, Log} from './http';
-import {buildArray, Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult} from './search';
+import { Request, Response } from 'express';
+import { handleError, Log } from './http';
+import { buildArray, Filter, format, fromRequest, getParameters, initializeConfig, jsonResult, SearchConfig, SearchResult } from './search';
 
 export class SearchController<T, S extends Filter> {
   config?: SearchConfig;
@@ -8,7 +8,13 @@ export class SearchController<T, S extends Filter> {
   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[]) {
+  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) {
       if (typeof config === 'boolean') {
@@ -30,8 +36,8 @@ export class SearchController<T, S extends Filter> {
     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)
-      .then(result => jsonResult(res, result, this.csv, l.fields, this.config))
-      .catch(err => handleError(err, res, this.log));
+    this.find(s2, l.limit, l.offsetOrNextPageToken, l.fields)
+      .then((result) => jsonResult(res, result, this.csv, l.fields, this.config))
+      .catch((err) => handleError(err, res, this.log));
   }
 }

package/src/http.ts

@@ -6,7 +6,7 @@ export type LogFunc = Log;
 
 Object.defineProperty(Error.prototype, 'toJSON', {
   value() {
-    const alt:any = {};
+    const alt: any = {};
     Object.getOwnPropertyNames(this).forEach(function (key) {
       // @ts-ignore
       alt[key] = this[key];
@@ -15,7 +15,7 @@ Object.defineProperty(Error.prototype, 'toJSON', {
     return alt;
   },
   configurable: true,
-  writable: true
+  writable: true,
 });
 export function handleError(err: any, res: Response, log?: (msg: string) => void) {
   if (log) {
@@ -51,7 +51,7 @@ export function respondModel<T>(obj: T, res: Response): void {
     res.status(404).json(null).end();
   }
 }
-export function queryRequiredParams(req: Request, res: Response, name: string, split?: string): string[]|undefined {
+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`);
@@ -120,7 +120,7 @@ export function queryRequiredNumber(req: Request, res: Response, name: string):
   const n = parseFloat(v);
   return n;
 }
-export function queryNumber(req: Request, name: string, d?: number): number | undefined {
+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) {
@@ -219,7 +219,7 @@ export function getNumber(req: Request, name: string, d?: number): number | unde
   const n = parseFloat(v);
   return n;
 }
-export function getInteger(req: Request, name: string, d?: number): number|undefined {
+export function getInteger(req: Request, name: string, d?: number): number | undefined {
   const v = req.params[name];
   if (!v || v.length === 0) {
     return d;
@@ -231,7 +231,7 @@ export function getInteger(req: Request, name: string, d?: number): number|undef
   const s = n.toFixed(0);
   return parseFloat(s);
 }
-export function getRequiredDate(req: Request, res: Response, name: string): Date|undefined {
+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`);
@@ -244,7 +244,7 @@ export function getRequiredDate(req: Request, res: Response, name: string): Date
   }
   return date;
 }
-export function getDate(req: Request, name: string, d?: Date): Date|undefined {
+export function getDate(req: Request, name: string, d?: Date): Date | undefined {
   const v = req.params[name];
   if (!v || v.length === 0) {
     return d;

package/src/index.ts

@@ -1,46 +1,44 @@
-import {NextFunction, Request, Response} from 'express';
-import {GenericController} from './GenericController';
-import {GenericSearchController} from './GenericSearchController';
-import {HealthController} from './HealthController';
-import {handleError, Log} from './http';
-import {LoadController} from './LoadController';
-import {LoadSearchController} from './LoadSearchController';
-import {LogController} from './LogController';
-import {Controller} from './LowCodeController';
-import {Service} from './LowCodeController';
-import {SearchController} from './SearchController';
+import { NextFunction, Request, Response } from 'express';
+import { GenericController } from './GenericController';
+import { GenericSearchController } from './GenericSearchController';
+import { HealthController } from './HealthController';
+import { handleError, Log } from './http';
+import { LoadController } from './LoadController';
+import { LoadSearchController } from './LoadSearchController';
+import { LogController } from './LogController';
+import { Controller, Service } from './LowCodeController';
+import { SearchController } from './SearchController';
 
-export {HealthController as HealthHandler};
-export {LogController as LogHandler};
-export {LoadController as LoadHandler};
-export {LoadController as ViewHandler};
+export { HealthController as HealthHandler, LoadController as LoadHandler, LogController as LogHandler, LoadController as ViewHandler };
 // export {LoadController as ViewController};
 
-export {GenericController as GenericHandler};
-export {SearchController as SearchHandler};
-export {LoadSearchController as LoadSearchHandler};
-export {GenericSearchController as GenericSearchHandler};
-export {Controller as Handler};
-export {Service as LowCodeService};
+export {
+  GenericController as GenericHandler,
+  GenericSearchController as GenericSearchHandler,
+  Controller as Handler,
+  LoadSearchController as LoadSearchHandler,
+  Service as LowCodeService,
+  SearchController as SearchHandler,
+};
 
-export * from './health';
 export * from './client';
+export * from './edit';
+export * from './GenericController';
+export * from './GenericSearchController';
+export * from './health';
 export * from './HealthController';
-export * from './LogController';
-export * from './log';
 export * from './http';
-export * from './metadata';
-export * from './view';
 export * from './LoadController';
-export * from './search_func';
-export * from './search';
-export * from './SearchController';
 export * from './LoadSearchController';
-export * from './resources';
-export * from './edit';
-export * from './GenericController';
-export * from './GenericSearchController';
+export * from './log';
+export * from './LogController';
 export * from './LowCodeController';
+export * from './metadata';
+export * from './resources';
+export * from './search';
+export * from './search_func';
+export * from './SearchController';
+export * from './view';
 
 export interface AccessConfig {
   origin?: string | string[];
@@ -87,7 +85,7 @@ export interface SavedService<T> {
 }
 export class SavedController<T> {
   constructor(public log: (msg: string) => void, public service: SavedService<T>, public item: string, id?: string) {
-    this.id = (id && id.length > 0 ? id : 'id');
+    this.id = id && id.length > 0 ? id : 'id';
     this.save = this.save.bind(this);
     this.remove = this.remove.bind(this);
     this.load = this.load.bind(this);
@@ -104,10 +102,12 @@ export class SavedController<T> {
       res.status(400).end(`'${this.item}' cannot be empty`);
       return;
     }
-    this.service.save(id, itemId).then(data => {
-      res.status(200).json(data).end();
-    })
-    .catch(err => handleError(err, res, this.log));
+    this.service
+      .save(id, itemId)
+      .then((data) => {
+        res.status(200).json(data).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
   remove(req: Request, res: Response) {
     const id = req.params[this.id];
@@ -120,10 +120,12 @@ export class SavedController<T> {
       res.status(400).end(`'${this.item}' cannot be empty`);
       return;
     }
-    this.service.remove(id, itemId).then(data => {
-      res.status(200).json(data).end();
-    })
-    .catch(err => handleError(err, res, this.log));
+    this.service
+      .remove(id, itemId)
+      .then((data) => {
+        res.status(200).json(data).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
   load(req: Request, res: Response) {
     const id = req.params[this.id];
@@ -131,10 +133,12 @@ export class SavedController<T> {
       res.status(400).end(`'${this.id}' cannot be empty`);
       return;
     }
-    this.service.load(id).then(data => {
-      res.status(200).json(data).end();
-    })
-    .catch(err => handleError(err, res, this.log));
+    this.service
+      .load(id)
+      .then((data) => {
+        res.status(200).json(data).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
 }
 export interface FollowService {
@@ -145,7 +149,7 @@ export interface FollowService {
 // tslint:disable-next-line:max-classes-per-file
 export class FollowController {
   constructor(public log: Log, public service: FollowService, public target: string, id: string) {
-    this.id = (id && id.length > 0 ? id : 'id');
+    this.id = id && id.length > 0 ? id : 'id';
     this.follow = this.follow.bind(this);
     this.unfollow = this.unfollow.bind(this);
     this.checkFollow = this.checkFollow.bind(this);
@@ -162,9 +166,12 @@ export class FollowController {
       res.status(400).end(`'${this.target}' cannot be empty`);
       return;
     }
-    this.service.follow(id, target).then(count => {
-      return res.status(200).json(count).end();
-    }).catch(err => handleError(err, res, this.log));
+    this.service
+      .follow(id, target)
+      .then((count) => {
+        return res.status(200).json(count).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
   unfollow(req: Request, res: Response): void {
     const id = req.params.id;
@@ -177,9 +184,12 @@ export class FollowController {
       res.status(400).end(`'${this.target}' cannot be empty`);
       return;
     }
-    this.service.unfollow(id, target).then(count => {
-      return res.status(200).json(count).end();
-    }).catch(err => handleError(err, res, this.log));
+    this.service
+      .unfollow(id, target)
+      .then((count) => {
+        return res.status(200).json(count).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
   checkFollow(req: Request, res: Response): void {
     const id = req.params.id;
@@ -192,9 +202,12 @@ export class FollowController {
       res.status(400).end(`'${this.target}' cannot be empty`);
       return;
     }
-    this.service.checkFollow(id, target).then(count => {
-      return res.status(200).json(count).end();
-    }).catch(err => handleError(err, res, this.log));
+    this.service
+      .checkFollow(id, target)
+      .then((count) => {
+        return res.status(200).json(count).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
 }
 export interface ReactService {
@@ -205,7 +218,7 @@ export interface ReactService {
 // tslint:disable-next-line:max-classes-per-file
 export class UserReactionController {
   constructor(public log: Log, public service: ReactService, public author: string, id: string, public reaction: string) {
-    this.id = (id && id.length > 0 ? id : 'id');
+    this.id = id && id.length > 0 ? id : 'id';
     this.react = this.react.bind(this);
     this.unreact = this.unreact.bind(this);
     this.checkReaction = this.checkReaction.bind(this);
@@ -227,9 +240,12 @@ export class UserReactionController {
       res.status(400).end(`'${this.reaction}' cannot be empty`);
       return;
     }
-    this.service.react(id, author, reaction).then(count => {
-      return res.status(200).json(count).end();
-    }).catch(err => handleError(err, res, this.log));
+    this.service
+      .react(id, author, reaction)
+      .then((count) => {
+        return res.status(200).json(count).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
   unreact(req: Request, res: Response): void {
     const id = req.params.id;
@@ -247,9 +263,12 @@ export class UserReactionController {
       res.status(400).end(`'${this.reaction}' cannot be empty`);
       return;
     }
-    this.service.unreact(id, author, reaction).then(count => {
-      return res.status(200).json(count).end();
-    }).catch(err => handleError(err, res, this.log));
+    this.service
+      .unreact(id, author, reaction)
+      .then((count) => {
+        return res.status(200).json(count).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
   checkReaction(req: Request, res: Response): void {
     const id = req.params.id;
@@ -262,9 +281,12 @@ export class UserReactionController {
       res.status(400).end(`'${this.author}' cannot be empty`);
       return;
     }
-    this.service.checkReaction(id, author).then(count => {
-      return res.status(200).json(count).end();
-    }).catch(err => handleError(err, res, this.log));
+    this.service
+      .checkReaction(id, author)
+      .then((count) => {
+        return res.status(200).json(count).end();
+      })
+      .catch((err) => handleError(err, res, this.log));
   }
 }
 export const ReactController = UserReactionController;

package/src/search.ts

@@ -1,6 +1,6 @@
-import {Request, Response} from 'express';
-import {minimizeArray} from './http';
-import {Attribute, Attributes} from './metadata';
+import { Request, Response } from 'express';
+import { minimizeArray } from './http';
+import { Attribute, Attributes } from './metadata';
 
 export interface Filter {
   fields?: string[];
@@ -29,6 +29,92 @@ export interface SearchResult<T> {
   last?: boolean;
 }
 
+export function getOffset(limit: number, page: number): number {
+  const offset = limit * (page - 1);
+  return offset < 0 ? 0 : offset;
+}
+
+export function getPageTotal(pageSize?: number, total?: number): number {
+  if (!pageSize || pageSize <= 0) {
+    return 1;
+  } else {
+    if (!total) {
+      total = 0;
+    }
+    if (total % pageSize === 0) {
+      return Math.floor(total / pageSize);
+    }
+    return Math.floor(total / pageSize + 1);
+  }
+}
+export function buildPages(pageSize?: number, total?: number): number[] {
+  const pageTotal = getPageTotal(pageSize, total);
+  if (pageTotal <= 1) {
+    return [1];
+  }
+  const arr: number[] = [];
+  for (let i = 1; i <= pageTotal; i++) {
+    arr.push(i);
+  }
+  return arr;
+}
+export function getPageQuery(query: string, page?: string): string {
+  const s = page && page.length > 0 ? page : 'page';
+  const i = query.indexOf(s + '=');
+  if (i < 0) {
+    return '';
+  }
+  const j = query.indexOf('&', i + s.length);
+  return j < 0 ? query.substring(i) : query.substring(i, j);
+}
+const PartialTrue = 'partial=true';
+export function removePageQuery(query: string, page?: string, partialIsTrue?: string): string {
+  if (query.length == 0) {
+    return query;
+  }
+  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);
+    }
+  }
+  const pageQuery = getPageQuery(query, page);
+  if (pageQuery.length == 0) {
+    return query;
+  } 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, '');
+  }
+}
+export function hasQuery(req: Request): boolean {
+  return req.url.indexOf('?') >= 0;
+}
+export function getQuery(url: string): string {
+  const i = url.indexOf('?');
+  return i < 0 ? '' : url.substring(i + 1);
+}
+export function buildPageQuery(query: string): string {
+  const qr = removePageQuery(query);
+  return qr.length == 0 ? qr : '&' + qr;
+}
+export function buildPageQueryFromUrl(url: string): string {
+  const query = getQuery(url);
+  return buildPageQuery(query);
+}
+
 export function jsonResult<T>(res: Response, result: SearchResult<T>, quick?: boolean, fields?: string[], config?: SearchConfig): void {
   if (quick && fields && fields.length > 0) {
     res.status(200).json(toCsv(fields, result)).end();
@@ -41,16 +127,16 @@ export function buildResult<T>(r: SearchResult<T>, conf?: SearchConfig): any {
     return r;
   }
   const x: any = {};
-  const li = (conf.list ? conf.list : 'list');
+  const li = conf.list ? conf.list : 'list';
   x[li] = minimizeArray(r.list);
-  const to = (conf.total ? conf.total : 'total');
+  const to = conf.total ? conf.total : 'total';
   x[to] = r.total;
   if (r.nextPageToken && r.nextPageToken.length > 0) {
-    const t = (conf.token ? conf.token : 'token');
+    const t = conf.token ? conf.token : 'token';
     x[t] = r.nextPageToken;
   }
   if (r.last) {
-    const l = (conf.last ? conf.last : 'last');
+    const l = conf.last ? conf.last : 'last';
     x[l] = r.last;
   }
   return x;
@@ -71,7 +157,7 @@ export function initializeConfig(conf?: SearchConfig): SearchConfig | undefined
     limit: conf.limit,
     skip: conf.skip,
     refId: conf.refId,
-    firstLimit: conf.firstLimit
+    firstLimit: conf.firstLimit,
   };
   if (!c.excluding || c.excluding.length === 0) {
     c.excluding = 'excluding';
@@ -109,7 +195,7 @@ export function initializeConfig(conf?: SearchConfig): SearchConfig | undefined
   return c;
 }
 export function fromRequest<S>(req: Request, arr?: string[]): S {
-  const s: any = (req.method === 'GET' ? fromUrl(req, arr) : req.body);
+  const s: any = req.method === 'GET' ? fromUrl(req, arr) : req.body;
   return s;
 }
 export function buildArray(arr?: string[], s0?: string, s1?: string, s2?: string): string[] {
@@ -212,10 +298,10 @@ const setKey = (_object: any, _isArrayKey: boolean, _key: string, _nextValue: an
 };
 export interface Limit {
   limit?: number;
-  skip?: number;
-  refId?: string;
+  offset?: number;
+  nextPageToken?: string;
   fields?: string[];
-  skipOrRefId?: string|number;
+  offsetOrNextPageToken?: string | number;
 }
 export function getParameters<T>(obj: T, config?: SearchConfig): Limit {
   const o: any = obj;
@@ -231,7 +317,7 @@ export function getParameters<T>(obj: T, config?: SearchConfig): Limit {
     if (!refId) {
       refId = o['nextPageToken'];
     }
-    const r: Limit = {fields, refId};
+    const r: Limit = { fields, nextPageToken: refId };
     let pageSize = o['limit'];
     if (!pageSize) {
       pageSize = o['pageSize'];
@@ -244,8 +330,8 @@ export function getParameters<T>(obj: T, config?: SearchConfig): Limit {
         if (skip && !isNaN(skip)) {
           const iskip = Math.floor(parseFloat(skip));
           if (iskip >= 0) {
-            r.skip = iskip;
-            r.skipOrRefId = r.skip;
+            r.offset = iskip;
+            r.offsetOrNextPageToken = r.offset;
             deletePageInfo(o);
             return r;
           }
@@ -272,27 +358,27 @@ export function getParameters<T>(obj: T, config?: SearchConfig): Limit {
           if (firstPageSize && !isNaN(firstPageSize)) {
             const ifirstPageSize = Math.floor(parseFloat(firstPageSize));
             if (ifirstPageSize > 0) {
-              r.skip = ipageSize * (ipageIndex - 2) + ifirstPageSize;
-              r.skipOrRefId = r.skip;
+              r.offset = ipageSize * (ipageIndex - 2) + ifirstPageSize;
+              r.offsetOrNextPageToken = r.offset;
               deletePageInfo(o);
               return r;
             }
           }
-          r.skip = ipageSize * (ipageIndex - 1);
-          r.skipOrRefId = r.skip;
+          r.offset = ipageSize * (ipageIndex - 1);
+          r.offsetOrNextPageToken = r.offset;
           deletePageInfo(o);
           return r;
         }
-        r.skip = 0;
-        if (r.refId && r.refId.length > 0) {
-          r.skipOrRefId = r.refId;
+        r.offset = 0;
+        if (r.nextPageToken && r.nextPageToken.length > 0) {
+          r.offsetOrNextPageToken = r.nextPageToken;
         }
         deletePageInfo(o);
         return r;
       }
     }
-    if (r.refId && r.refId.length > 0) {
-      r.skipOrRefId = r.refId;
+    if (r.nextPageToken && r.nextPageToken.length > 0) {
+      r.offsetOrNextPageToken = r.nextPageToken;
     }
     deletePageInfo(o);
     return r;
@@ -312,7 +398,7 @@ export function getParameters<T>(obj: T, config?: SearchConfig): Limit {
       strRefId = 'refId';
     }
     const refId = o[strRefId];
-    const r: Limit = {fields, refId};
+    const r: Limit = { fields, nextPageToken: refId };
 
     let strLimit = config.limit;
     if (!strLimit || strLimit.length === 0) {
@@ -332,8 +418,8 @@ export function getParameters<T>(obj: T, config?: SearchConfig): Limit {
         if (skip && !isNaN(skip)) {
           const iskip = Math.floor(parseFloat(skip));
           if (iskip >= 0) {
-            r.skip = iskip;
-            r.skipOrRefId = r.skip;
+            r.offset = iskip;
+            r.offsetOrNextPageToken = r.offset;
             deletePageInfo(o, arr);
             return r;
           }
@@ -356,27 +442,27 @@ export function getParameters<T>(obj: T, config?: SearchConfig): Limit {
           if (firstPageSize && !isNaN(firstPageSize)) {
             const ifirstPageSize = Math.floor(parseFloat(firstPageSize));
             if (ifirstPageSize > 0) {
-              r.skip = ipageSize * (ipageIndex - 2) + ifirstPageSize;
-              r.skipOrRefId = r.skip;
+              r.offset = ipageSize * (ipageIndex - 2) + ifirstPageSize;
+              r.offsetOrNextPageToken = r.offset;
               deletePageInfo(o, arr);
               return r;
             }
           }
-          r.skip = ipageSize * (ipageIndex - 1);
-          r.skipOrRefId = r.skip;
+          r.offset = ipageSize * (ipageIndex - 1);
+          r.offsetOrNextPageToken = r.offset;
           deletePageInfo(o, arr);
           return r;
         }
-        r.skip = 0;
-        if (r.refId && r.refId.length > 0) {
-          r.skipOrRefId = r.refId;
+        r.offset = 0;
+        if (r.nextPageToken && r.nextPageToken.length > 0) {
+          r.offsetOrNextPageToken = r.nextPageToken;
         }
         deletePageInfo(o, arr);
         return r;
       }
     }
-    if (r.refId && r.refId.length > 0) {
-      r.skipOrRefId = r.refId;
+    if (r.nextPageToken && r.nextPageToken.length > 0) {
+      r.offsetOrNextPageToken = r.nextPageToken;
     }
     deletePageInfo(o, arr);
     return r;