lemon-core 3.1.1 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lemon-core",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "Lemon Serverless Micro-Service Platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -49,34 +49,36 @@
   "dependencies": {
     "@elastic/elasticsearch": "7.12",
     "@types/aws-lambda": "^8.10.62",
-    "@types/express": "^4.17.8",
-    "@types/ioredis": "^4.17.8",
-    "@types/jsonwebtoken": "^8.5.0",
-    "@types/lodash": "^4.14.180",
-    "async": "^3.2.0",
+    "@types/express": "^4.17.11",
+    "@types/express-serve-static-core": "^4.17.19",
+    "@types/ioredis": "^4.28.10",
+    "@types/jsonwebtoken": "^8.5.9",
+    "@types/lodash": "^4.14.185",
+    "async": "^3.2.4",
     "aws-lambda": "^1.0.6",
     "aws-sdk": "2.814",
-    "body-parser": "^1.19.0",
-    "cookie-parser": "^1.4.5",
+    "body-parser": "^1.20.0",
+    "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
-    "express": "^4.16.4",
-    "ioredis": "^4.19.2",
-    "js-yaml": "^3.14.0",
-    "jsonwebtoken": "^8.5.1",
+    "express": "^4.18.1",
+    "ioredis": "^5.2.3",
+    "js-yaml": "^4.1.0",
+    "jsonwebtoken": "^9.0.0",
+    "lemon-model": "^1.0.1",
     "lodash": "^4.17.21",
     "memcached": "^2.2.2",
-    "mime-types": "^2.1.27",
-    "multer": "^1.4.1",
+    "mime-types": "^2.1.35",
+    "multer": "^1.4.5-lts.1",
     "node-cache": "^5.1.2",
-    "query-string": "^6.13.1",
+    "query-string": "^7.1.1",
     "request": "^2.88.2",
-    "request-ip": "^2.1.3",
-    "source-map-support": "^0.5.19",
+    "request-ip": "^3.3.0",
+    "source-map-support": "^0.5.21",
     "ts-transformer-keys": "^0.4.3",
-    "uuid": "^3.4.0"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@types/async": "^3.2.3",
+    "@types/async": "^3.2.15",
     "@types/cookie-parser": "^1.4.2",
     "@types/cors": "^2.8.7",
     "@types/dotenv": "^6.1.1",
@@ -84,33 +86,32 @@
     "@types/js-yaml": "^3.12.5",
     "@types/memcached": "^2.2.6",
     "@types/mime-types": "^2.1.0",
-    "@types/multer": "^1.4.4",
-    "@types/request": "^2.48.5",
+    "@types/multer": "^1.4.7",
+    "@types/request": "^2.48.8",
     "@types/request-ip": "0.0.34",
     "@types/supertest": "^2.0.10",
-    "@types/uuid": "^3.4.9",
+    "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^5.15.0",
     "@typescript-eslint/parser": "^5.15.0",
     "codecov": "^3.7.2",
     "concurrently": "^5.3.0",
     "dotenv": "^8.2.0",
-    "eslint": "^8.11.0",
+    "eslint": "^8.23.1",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
     "faker": "^4.1.0",
     "gh-pages": "^2.2.0",
-    "husky": "^2.2.0",
+    "husky": "^2.7.0",
     "jest": "^27.5.1",
-    "lint-staged": "^8.1.6",
-    "plato": "^1.7.0",
-    "prettier": "^2.6.0",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1",
     "superagent": "^5.3.1",
     "supertest": "^4.0.2",
-    "ts-jest": "^27.1.3",
+    "ts-jest": "^27.1.5",
     "ts-node": "^8.10.2",
     "ttypescript": "^1.5.13",
-    "typedoc": "^0.15.8",
-    "typescript": "^4.6.2"
+    "typedoc": "^0.23.15",
+    "typescript": "^4.8.3"
   },
   "private": false,
   "repository": {

package/dist/cores/api-service.d.ts

@@ -1,239 +0,0 @@
-/**
- * API headers.
- */
-export interface APIHeaders {
-    [key: string]: string;
-}
-/**
- * class: `APIServiceClient`
- * - General API Request Client w/ url like `GET <endpoint>/<id>?/<cmd>?`
- */
-export interface APIServiceClient {
-    hello(): string;
-    doGet<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPut<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPost<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPatch<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doDelete<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-}
-/**
- * possible method.
- */
-export declare type APIHttpMethod = 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE';
-/**
- * class: `ApiHttpProxy`
- * - http proxy service.
- */
-export interface ApiHttpProxy {
-    /**
-     * say this service name.
-     */
-    hello(): string;
-    /**
-     * call http request via proxy server.
-     *
-     * url := `<host>/<path?>?<param>`
-     *
-     * @param method    http method
-     * @param host      host name (or https://~)
-     * @param path      object id
-     * @param param     query paramters
-     * @param body      body
-     * @param ctx       context
-     * @param hash      (optional) hash value (valid only for client-side).
-     */
-    doProxy<T = any>(method: APIHttpMethod, host: string, path?: string, param?: any, body?: any, ctx?: any, hash?: string): Promise<T>;
-}
-/**
- * class: `APIProxyClient`
- * - proxed APIServiceClient
- */
-export declare class APIProxyClient implements APIServiceClient {
-    protected service: APIServiceClient;
-    constructor(service: APIServiceClient);
-    hello: () => string;
-    doGet<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPut<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPost<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPatch<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doDelete<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-}
-/**
- * class: `APIService`
- * - use internal http-proxy service due to restriction internet-face in VPC lambda.
- */
-export declare class APIService implements APIServiceClient {
-    protected type: string;
-    protected endpoint: string;
-    protected headers: APIHeaders;
-    protected client: APIServiceClient;
-    /**
-     * create API service.
-     *
-     * ```js
-     * // basic
-     * const api = new API('web', 'http://localhost:8081', {});
-     * api.doGet('');
-     *
-     * // via python
-     * const api = new API('residents', 'http://localhost:8113', {});
-     * api.doGet('123');    // http GET :8113/residents/123
-     *
-     * // proxy server
-     * const api = new API('web', 'http://localhost:8081', {}, null, proxy);
-     * api.doGet('');
-     * ```
-     *
-     * @param type      type in endpoint
-     * @param endpoint  base endpoint (support ONLY http, https)
-     * @param headers   common headers.
-     * @param client    real api-client to use (or use proxy, or create default)
-     * @param proxy     proxy-service to use if there is no client (or use backbone server)
-     */
-    constructor(type: string, endpoint: string, headers?: APIHeaders, client?: APIServiceClient, proxy?: ApiHttpProxy);
-    hello: () => string;
-    /**
-     * helper to make http client
-     *
-     * @param backbone  backbone address like 'http://localhost:8081'
-     */
-    static buildClient(type: string, endpoint: string, headers?: APIHeaders, backbone?: string, proxy?: ApiHttpProxy): APIServiceClient;
-    /**
-     * make a client for sub-typed endpoint.
-     * @param type      sub-type path.
-     */
-    buildSubTypeClient(type: string, useRecord?: boolean, folder?: string): APIServiceClient;
-    /**
-     * make api recorder of this service.
-     * @param folder    base folder (default `./logs`)
-     */
-    buildRecorder(folder?: string): APIServiceClient;
-    /**
-     * class: `TypedEndpoint`
-     * - by using common proxy, extends endpoint by type.
-     * - endpoint := base+'/'+type.
-     */
-    private static ProxyServiceClient;
-    /**
-     * use sub-typed endpoint.
-     * - extends as endpoint := parent.endpoint + '/' + type
-     */
-    static SubTypeClient: {
-        new (parent: APIServiceClient, type: string): {
-            readonly parent: APIServiceClient;
-            readonly type: string;
-            hello: () => string;
-            asCmd: (id: string, cmd?: string) => string;
-            doGet(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doPut(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doPost(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doPatch(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doDelete(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-        };
-    };
-    /**
-     * recorder of api-http-proxy client.
-     */
-    static ApiHttpProxyRecorder: {
-        new (target: ApiHttpProxy, folder?: string): {
-            readonly target: ApiHttpProxy;
-            readonly folder: string;
-            hello: () => string;
-            doProxy<T = any>(method: APIHttpMethod, host: string, path?: string, param?: any, body?: any, context?: any, hash?: string): Promise<T>;
-        };
-        next: number;
-    };
-    /**
-     * recorder of api-service client.
-     */
-    static APIServiceClientRecorder: {
-        new (target: APIServiceClient, endpoint: string, folder?: string): {
-            readonly target: APIServiceClient;
-            readonly endpoint: string;
-            readonly folder: string;
-            hello: () => string;
-            doRecord(method: APIHttpMethod, id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doGet(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doPut(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doPost(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doPatch(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-            doDelete(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any>;
-        };
-        next: number;
-    };
-    /**
-     * GET HOST/PATH?$param
-     */
-    doGet: (id: string, cmd?: string, $param?: any, $body?: any, hash?: string) => Promise<any>;
-    /**
-     * PUT HOST/PATH?$param
-     */
-    doPut: (id: string, cmd?: string, $param?: any, $body?: any, hash?: string) => Promise<any>;
-    /**
-     * POST HOST/PATH?$param
-     */
-    doPost: (id: string, cmd?: string, $param?: any, $body?: any, hash?: string) => Promise<any>;
-    /**
-     * PATCH HOST/PATH?$param
-     */
-    doPatch: (id: string, cmd?: string, $param?: any, $body?: any, hash?: string) => Promise<any>;
-    /**
-     * DELETE HOST/PATH?$param
-     */
-    doDelete: (id: string, cmd?: string, $param?: any, $body?: any, hash?: string) => Promise<any>;
-}
-/**
- * create http-web-proxy agent which using endpoint as proxy server.
- *
- * # as cases.
- * as proxy agent: GET <endpoint>/<host?>/<path?>
- * as direct agent: GET <endpoint>/<id?>/<cmd?>
- *
- * @param name              client-name
- * @param endpoint          service url (or backbone proxy-url)
- * @param headers           headers
- * @param encoder           path encoder (default encodeURIComponent)
- * @param relayHeaderKey    relay-key in headers for proxy.
- * @param resultKey         resultKey in response
- */
-export declare const createHttpWebProxy: (name: string, endpoint: string, headers?: APIHeaders, encoder?: (name: string, path: string) => string, relayHeaderKey?: string, resultKey?: string) => ApiHttpProxy;
-/** ********************************************************************************************************************
- *  MOCKS API-SERVICE
- ** ********************************************************************************************************************/
-/**
- * class: `MocksAPIService`
- * - use <mock>.json file in `./data/mocks/` instead of real http request.
- * - it redirect to url like `endpoint/type/id/cmd`
- *
- * ```ts
- * // json format
- * {
- *    param: {          // input format
- *      method: string;
- *      endpoint: string;
- *      id?: string;
- *      cmd?: string;
- *    },
- *    data: {           // response data
- *      ...
- *    },
- *    error?: string;   // in case of error.
- * }
- * ```
- */
-export declare class MocksAPIService implements ApiHttpProxy, APIServiceClient {
-    private $map;
-    private type;
-    private endpoint;
-    constructor(type: string, endpoint: string);
-    protected loadSync(): void;
-    protected asPath: (id?: string, cmd?: string) => string;
-    doProxy<T = any>(method: APIHttpMethod, type: string, path: string, param?: any, body?: any, ctx?: any, hash?: string): Promise<T>;
-    protected na: (a: any, x: string, y: string) => string;
-    hello: () => string;
-    doGet<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPut<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPost<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doPatch<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-    doDelete<T = any>(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<T>;
-}