@sera4/essentia 3.0.11 → 3.0.13-rc.1

package/dist/cache/index.d.ts

@@ -0,0 +1,22 @@
+export default function _default(config: any, servicePrefix: any): Cache;
+declare class Cache {
+    constructor(config: any, servicePrefix: any);
+    redisClient: any;
+    servicePrefix: any;
+    ping(): any;
+    properKey(key: any, path: any): any;
+    writeHash(path: any, key: any, value: any): any;
+    writeHashBlocking(path: any, key: any, value: any): any;
+    writeMultiHash(path: any, j: any): any;
+    readHashKey(obj: any, key: any, autoConvert?: boolean): Promise<any>;
+    readHash(path: any): Promise<any>;
+    deleteHashKey(hash: any, key: any): Promise<any>;
+    get(key: any): any;
+    getAsync(key: any): any;
+    writeKey(key: any, value: any, expiry: any): any;
+    deleteKey(key: any): any;
+    expire(path: any, expiry: any): any;
+    exists(path: any): any;
+    deleteAllKeys(): Promise<any>;
+}
+export {};

package/dist/cache/index.js

@@ -0,0 +1,166 @@
+"use strict";
+import { promisify } from "util";
+const isEmpty = obj => [Object, Array].includes((obj || {}).constructor) && !Object.entries((obj || {})).length;
+class CacheConfigError extends Error {
+    constructor(m) {
+        super(m);
+    }
+}
+/* Redis cache helper
+ * Example use: Place the following code in your project to setup redis use
+ *
+ *    import { cache } from "@sera4/essentia";
+ *    const cacheHelper = cache({ password: .., database: .., host: .., port: .. }, "service:"));
+ *
+ */
+const convertRedisKeyValueToJson = (v) => {
+    return (v && v.length > 0 && v[0] !== null) ? JSON.parse(v) : null;
+};
+const convertRedisHashToJson = (v) => {
+    if (v) {
+        var result = {};
+        for (var k in v) {
+            if (v.hasOwnProperty(k)) {
+                result[k] = JSON.parse(v[k]);
+            }
+        }
+        return result;
+    }
+    else {
+        return null;
+    }
+};
+function convertJsonToRedisValue(j) {
+    var result = {};
+    for (var key in j) {
+        if (j.hasOwnProperty(key)) {
+            result[key] = JSON.stringify(j[key]);
+        }
+    }
+    return result;
+}
+class Cache {
+    constructor(config, servicePrefix) {
+        if ((config == undefined) || isEmpty(config)) {
+            throw new CacheConfigError("Invalid cache configuration");
+        }
+        if (servicePrefix == null) {
+            throw new CacheConfigError("Invalid service prefix");
+        }
+        if (config.fake) {
+            // used in testing
+            this.redisClient = require("fakeredis").createClient("fake backend");
+        }
+        else {
+            this.redisClient = require("redis").createClient(config);
+        }
+        this.redisClient.on("error", (err) => {
+            logger.error("Cache/Redis error: ", err);
+        });
+        this.servicePrefix = servicePrefix;
+    }
+    ping() {
+        return this.redisClient.ping();
+    }
+    properKey(key, path) {
+        let p = this.servicePrefix + key;
+        if (path)
+            p += path;
+        return p;
+    }
+    writeHash(path, key, value) {
+        return this.redisClient.hsetAsync(properKey(key), key, value);
+    }
+    writeHashBlocking(path, key, value) {
+        return this.redisClient.hset(properKey(key), key, value);
+    }
+    // write multiple hash keys and stringify every value
+    writeMultiHash(path, j) {
+        return this.redisClient.hmsetAsync(properKey(key), convertJsonToRedisValue(j));
+    }
+    readHashKey(obj, key, autoConvert = true) {
+        var k = autoConvert;
+        return new Promise((resolve, reject) => {
+            this.redisClient.hget(properKey(key, obj), key, (e, r) => {
+                if (e) {
+                    logger.error("Redis hmget error:", e);
+                    reject(e);
+                }
+                else {
+                    resolve(k ? convertRedisKeyValueToJson(r) : r);
+                }
+            });
+        });
+    }
+    readHash(path) {
+        return new Promise((resolve, reject) => {
+            this.redisClient.hgetall(properKey(key, path), (e, r) => {
+                if (e) {
+                    console.log("Redis hget error:", e);
+                    reject(e);
+                }
+                else {
+                    resolve(convertRedisHashToJson(r));
+                }
+            });
+        });
+    }
+    deleteHashKey(hash, key) {
+        return new Promise((resolve, reject) => {
+            this.redisClient.hdel(properKey(key, hash), key, (err) => {
+                if (err) {
+                    logger.error("Redis hdel error:", err);
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    }
+    get(key) {
+        return this.redisClient.getAsync(properKey(key));
+    }
+    getAsync(key) {
+        return promisify(this.redisClient.get(key)).bind(this.redisClient);
+    }
+    /* a single key write with optional expiry */
+    // returns bluebird promise
+    writeKey(key, value, expiry) {
+        key = this.servicePrefix + key;
+        if (expiry) {
+            return this.redisClient.setAsync(key, value, "EX", expiry);
+        }
+        else {
+            return this.redisClient.setAsync(key, value);
+        }
+    }
+    deleteKey(key) {
+        return redisClient.delAsync(properKey(key));
+    }
+    expire(path, expiry) {
+        return this.redisClient.expire(path, expiry);
+    }
+    exists(path) {
+        return this.redisClient.exists(path);
+    }
+    deleteAllKeys() {
+        return new Promise((resolve, reject) => {
+            if (process.env.NODE_ENV === "production") {
+                throw new Error("Clearing system cache is not permitted in production");
+            }
+            this.redisClient.flushdb((err, res) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve(res);
+                }
+            });
+        });
+    }
+}
+export default function (config, servicePrefix) {
+    return new Cache(config, servicePrefix);
+}
+//# sourceMappingURL=index.js.map

package/dist/cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../cache/index.js"],"names":[],"mappings":"AAAA,YAAY,CAAA;AAEZ,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjC,MAAM,OAAO,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAEhH,MAAM,gBAAiB,SAAQ,KAAK;IAClC,YAAY,CAAC;QACX,KAAK,CAAC,CAAC,CAAC,CAAC;IACX,CAAC;CACF;AAED;;;;;;GAMG;AAEH,MAAM,0BAA0B,GAAG,CAAC,CAAC,EAAE,EAAE;IACvC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACrE,CAAC,CAAA;AAED,MAAM,sBAAsB,GAAG,CAAC,CAAC,EAAE,EAAE;IACnC,IAAI,CAAC,EAAE,CAAC;QACN,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,KAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACf,IAAI,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;gBACxB,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAA;AAED,SAAS,uBAAuB,CAAC,CAAC;IAChC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;QAClB,IAAI,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,KAAK;IACT,YAAY,MAAM,EAAE,aAAa;QAC/B,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,gBAAgB,CAAC,6BAA6B,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,MAAM,IAAI,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,kBAAkB;YAClB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;QACtE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACnC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IACjC,CAAC;IAED,SAAS,CAAC,GAAG,EAAE,IAAI;QACjB,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,GAAG,GAAG,CAAA;QAChC,IAAI,IAAI;YACN,CAAC,IAAI,IAAI,CAAA;QACX,OAAO,CAAC,CAAA;IACV,CAAC;IAED,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK;QACxB,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,qDAAqD;IACrD,cAAc,CAAC,IAAI,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;IACjF,CAAC;IAED,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,GAAC,IAAI;QACpC,IAAI,CAAC,GAAG,WAAW,CAAC;QAEpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACvD,IAAI,CAAC,EAAE,CAAC;oBACN,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC;oBACtC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACZ,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,IAAI;QACX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACtD,IAAI,CAAC,EAAE,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;oBACpC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACZ,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,IAAI,EAAE,GAAG;QACrB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;gBACvD,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;oBACvC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,GAAG;QACL,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,QAAQ,CAAC,GAAG;QACV,OAAO,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACpE,CAAC;IAGD,6CAA6C;IAC7C,2BAA2B;IAC3B,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM;QACzB,GAAG,GAAG,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;QAC/B,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,SAAS,CAAC,GAAG;QACX,OAAO,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,IAAI,EAAE,MAAM;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,IAAI;QACT,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,aAAa;QACX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACpC,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,CAAC;gBACf,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,CAAC,OAAO,WAAU,MAAM,EAAE,aAAa;IAC3C,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;AACzC,CAAC"}

package/dist/constants/index.d.ts

@@ -0,0 +1,6 @@
+export const TWS_ROUTE_TYPES: Readonly<{
+    web: 1;
+    mobile: 2;
+    api: 3;
+    other: 4;
+}>;

package/dist/constants/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// indicate what target URL was used for a request
+export const TWS_ROUTE_TYPES = Object.freeze({
+    'web': 1,
+    'mobile': 2,
+    'api': 3,
+    'other': 4
+});
+//# sourceMappingURL=index.js.map

package/dist/constants/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../constants/index.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,kDAAkD;AAClD,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,KAAK,EAAE,CAAC;IACR,QAAQ,EAAE,CAAC;IACX,KAAK,EAAE,CAAC;IACR,OAAO,EAAE,CAAC;CACX,CAAC,CAAC"}

package/dist/formatter/index.d.ts

@@ -0,0 +1,37 @@
+export default formatter;
+declare const formatter: S4Formatter;
+declare class S4Formatter {
+    defaults: {
+        status: number;
+        errors: {};
+    };
+    _isArray(value: any): boolean;
+    _fromHash(error: any): {
+        status: number;
+        errors: {};
+    };
+    /**
+    * Desired Response format
+    *{
+    *    "error": {
+    *        "status": 422,
+    *        "errors": {
+    *            "password": {
+    *                "location": "body",
+    *                "param": "password",
+    *                "value": "mypassword",
+    *                "msg": "weak"
+    *            }
+    *        }
+    *    },
+    *    "error_id": "a2ddf895-2aaf-4189-88a2-8e11f6843f91"
+    *}
+    */
+    formatError(error: any): FormatError | {
+        status: number;
+        errors: {};
+    };
+}
+declare class FormatError extends Error {
+    constructor(m: any);
+}

package/dist/formatter/index.js

@@ -0,0 +1,75 @@
+"use strict";
+class FormatError extends Error {
+    constructor(m) {
+        super(m);
+    }
+}
+// helps to clean up response formats for services responding to rest requests
+class S4Formatter {
+    constructor() {
+        this.defaults = {
+            status: 422,
+            errors: {}
+        };
+    }
+    _isArray(value) {
+        return value && typeof value === 'object' && value.constructor === Array;
+    }
+    _fromHash(error) {
+        let response = Object.assign({}, this.defaults);
+        if (error.status) {
+            let errorStatus = parseInt(error.status);
+            if ((errorStatus >= 200) && (errorStatus < 522)) {
+                response.status = errorStatus;
+            }
+        }
+        if (error.error && (typeof (error.error) === "string")) {
+            response.errors["generic"] = { msg: error.error };
+        }
+        else if (error.errors) {
+            if (this._isArray(error.errors)) {
+                // many legacy responses which are errors: ["error_name"]
+                error.errors.forEach(function (el, index) {
+                    response.errors[`generic_${index}`] = { msg: el };
+                });
+            }
+            else if (typeof (error.errors) === "object") {
+                response.errors = error.errors;
+            }
+        }
+        return response;
+    }
+    /**
+    * Desired Response format
+    *{
+    *    "error": {
+    *        "status": 422,
+    *        "errors": {
+    *            "password": {
+    *                "location": "body",
+    *                "param": "password",
+    *                "value": "mypassword",
+    *                "msg": "weak"
+    *            }
+    *        }
+    *    },
+    *    "error_id": "a2ddf895-2aaf-4189-88a2-8e11f6843f91"
+    *}
+    */
+    formatError(error) {
+        let response;
+        if (error === null) {
+            response = this.defaults;
+        }
+        else if (typeof (error) === "object") {
+            response = this._fromHash(error);
+        }
+        else {
+            return new FormatError("invalid_error_format");
+        }
+        return response;
+    }
+}
+const formatter = new S4Formatter();
+export default formatter;
+//# sourceMappingURL=index.js.map

package/dist/formatter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../formatter/index.js"],"names":[],"mappings":"AAAA,YAAY,CAAA;AAEZ,MAAM,WAAY,SAAQ,KAAK;IAC7B,YAAY,CAAC;QACX,KAAK,CAAC,CAAC,CAAC,CAAC;IACX,CAAC;CACF;AAED,8EAA8E;AAC9E,MAAM,WAAW;IACf;QACE,IAAI,CAAC,QAAQ,GAAG;YACd,MAAM,EAAE,GAAG;YACX,MAAM,EAAE,EAAE;SACX,CAAC;IACJ,CAAC;IAED,QAAQ,CAAE,KAAK;QACb,OAAO,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,WAAW,KAAK,KAAK,CAAC;IAC3E,CAAC;IAED,SAAS,CAAC,KAAK;QACb,IAAI,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEzC,IAAI,CAAC,WAAW,IAAI,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,EAAE,CAAC;gBAChD,QAAQ,CAAC,MAAM,GAAG,WAAW,CAAA;YAC/B,CAAC;QACH,CAAC;QAED,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC,OAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;YACtD,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE,CAAA;QACnD,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChC,yDAAyD;gBACzD,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,UAAS,EAAE,EAAE,KAAK;oBACrC,QAAQ,CAAC,MAAM,CAAC,WAAW,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAA;gBACnD,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,IAAI,OAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC7C,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;YAChC,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;MAgBE;IACF,WAAW,CAAC,KAAK;QACf,IAAI,QAAQ,CAAC;QACb,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC3B,CAAC;aAAM,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAG,CAAC;YACvC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,WAAW,CAAC,sBAAsB,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAED,MAAM,SAAS,GAAG,IAAI,WAAW,EAAE,CAAC;AACpC,eAAe,SAAS,CAAC"}

package/dist/hal/index.d.ts

@@ -0,0 +1,5 @@
+export default halDecorator;
+declare const halDecorator: HalDecorator;
+declare class HalDecorator {
+    decorate(Model: any, options: any): void;
+}

package/dist/hal/index.js

@@ -0,0 +1,69 @@
+"use strict";
+function lastElement(arr) {
+    if (arr && arr.length) {
+        return arr[arr.length - 1];
+    }
+    else {
+        return null;
+    }
+}
+class HalDecorator {
+    decorate(Model, options) {
+        const model = Model.instance || Model;
+        const resource = (options && options.resource) ? options.resource : "";
+        const exclude = (options && options.exclude) ? options.exclude : [];
+        const links = (options && options.links) ? options.links : {};
+        const linksTag = (options && options.linksTag) ? options.linksTag : "_links";
+        const resourceTag = (options && options.resourceTag) ? options.resourceTag : "_resource";
+        const link = (name, method, l) => {
+            if (name && method && l) {
+                var aLink = {};
+                alink[method] = l;
+                links[name] = aLink;
+            }
+            return model;
+        };
+        const getLinkData = (values) => {
+            var linkData = {};
+            if (links) {
+                for (const key in links) {
+                    if (links.hasOwnProperty(key)) {
+                        const link = links[key];
+                        const method = lastElement(Object.keys(link));
+                        var url = link[method];
+                        const paramPattern = /\:([a-zA-z_0-9]*)/;
+                        const arr = paramPattern.exec(url);
+                        if (arr) {
+                            // Replace parameters
+                            url = `/${resource}/${url.split(arr[0]).join(values[arr[1]])}`;
+                            // Remove extra slashes that may have been added
+                            url = url.replace(/\/\/*/g, "/");
+                            linkData[key] = {};
+                            linkData[key][method] = url;
+                        }
+                    }
+                }
+            }
+            return Object.keys(linkData).length > 0 ? linkData : null;
+        };
+        model.link = link;
+        Model.prototype.toJSON = function () {
+            var values = Object.assign({}, this.get());
+            if (exclude) {
+                exclude.forEach(element => {
+                    delete values[element];
+                });
+            }
+            const links = getLinkData(values);
+            const result = {};
+            if (links) {
+                result[linksTag] = links;
+            }
+            result[resourceTag] = values;
+            return result;
+        };
+    }
+}
+const halDecorator = new HalDecorator();
+export default halDecorator;
+//# sourceMappingURL=index.js.map

package/dist/hal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../hal/index.js"],"names":[],"mappings":"AAAA,YAAY,CAAA;AAEZ,SAAS,WAAW,CAAC,GAAG;IACtB,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACtB,OAAO,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,YAAY;IAEhB,QAAQ,CAAC,KAAK,EAAE,OAAO;QACrB,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC;QACtC,MAAM,QAAQ,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,MAAM,OAAO,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,MAAM,KAAK,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,MAAM,QAAQ,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC7E,MAAM,WAAW,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;QAEzF,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/B,IAAI,IAAI,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;gBACxB,IAAI,KAAK,GAAG,EAAE,CAAC;gBACf,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACtB,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAA;QAED,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,EAAE;YAC7B,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;oBACxB,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;wBAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;wBACxB,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;wBAC9C,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;wBACvB,MAAM,YAAY,GAAG,mBAAmB,CAAC;wBACzC,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBACnC,IAAI,GAAG,EAAE,CAAC;4BACR,qBAAqB;4BACrB,GAAG,GAAG,IAAI,QAAQ,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;4BAC/D,gDAAgD;4BAChD,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;4BACjC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;4BAClB,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;wBAC9B,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5D,CAAC,CAAA;QAED,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG;YACvB,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAC3C,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBACxB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;gBACzB,CAAC,CAAC,CAAC;YACL,CAAC;YACD,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;YAClC,MAAM,MAAM,GAAG,EAAE,CAAA;YACjB,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;YAC3B,CAAC;YACD,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;YAC7B,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAGD,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;AACxC,eAAe,YAAY,CAAC"}

package/dist/health/health-logger.d.ts

@@ -0,0 +1,9 @@
+export default helpers;
+declare namespace helpers {
+    function debug(...args: any[]): void;
+    function log(...args: any[]): void;
+    function warn(...args: any[]): void;
+    function info(...args: any[]): void;
+    function error(...args: any[]): void;
+    function setEnabled(e: any): void;
+}

package/dist/health/health-logger.js

@@ -0,0 +1,34 @@
+import logger from "../logger/s4-logger.js";
+let enabled = false;
+const helpers = {
+    debug(...args) {
+        if (enabled) {
+            logger.debug(":: HealthCheck ::", args);
+        }
+    },
+    log(...args) {
+        if (enabled) {
+            logger.debug(":: HealthCheck ::", args);
+        }
+    },
+    warn(...args) {
+        if (enabled) {
+            logger.warn(":: HealthCheck ::", args);
+        }
+    },
+    info(...args) {
+        if (enabled) {
+            logger.info(":: HealthCheck ::", args);
+        }
+    },
+    error(...args) {
+        if (enabled) {
+            logger.error(":: HealthCheck ::", args);
+        }
+    },
+    setEnabled(e) {
+        enabled = e;
+    }
+};
+export default helpers;
+//# sourceMappingURL=health-logger.js.map

package/dist/health/health-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health-logger.js","sourceRoot":"","sources":["../../health/health-logger.js"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,wBAAwB,CAAC;AAC5C,IAAI,OAAO,GAAG,KAAK,CAAC;AAEpB,MAAM,OAAO,GAAG;IACd,KAAK,CAAC,GAAG,IAAI;QACX,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,GAAG,CAAC,GAAG,IAAI;QACT,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,IAAI,CAAC,GAAG,IAAI;QACV,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,IAAI,CAAC,GAAG,IAAI;QACV,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,IAAI;QACX,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,UAAU,CAAC,CAAC;QACV,OAAO,GAAG,CAAC,CAAC;IACd,CAAC;CACF,CAAA;AAED,eAAe,OAAO,CAAC"}

package/dist/health/index.d.ts

@@ -0,0 +1,19 @@
+export class HealthCheck {
+    constructor(appendData?: {}, enableLogging?: boolean);
+    defaultResponse: {
+        status: number;
+        errors: {};
+    };
+    defaultPathRoute: string;
+    suppressLogs: boolean;
+    lastCallId: number;
+    pathPrefix: string;
+    healthChecks: any[];
+    addCheck(fcn: any): void;
+    setPrefix(prefix: any): void;
+    defaultPath(prefix?: string): string;
+    routes(router: any): any;
+    suppressHealthCheckLog(app: any): void;
+    setupCheck(config: any): void;
+    checkHealth(req: any, res: any): Promise<void>;
+}

package/dist/health/index.js

@@ -0,0 +1,175 @@
+"use strict";
+import pathHelper from "path";
+import logger from "./health-logger.js";
+import morgan from "morgan";
+class HealthCheckError extends Error {
+}
+/* Health Checking router + controller for use in all of our modules
+ * Example use: Place the following code in your routes file
+ *
+ *    import { healthCheck } from "@sera4/essentia";
+ *    const router = require('express').Router();
+ *
+ *      ....
+ *
+ *    const checkRedis = async () => { await cache.ping(); }
+ *    hc.setupCheck({ name: "redis", checkResult: false, critical: true, healthFunction: checkRedis });
+ *    app.use(hc.defaultPath(serverConfigs.api_prefix), hc.routes(router));
+ *
+ */
+class HealthCheck {
+    constructor(appendData = {}, enableLogging = true) {
+        logger.setEnabled(enableLogging);
+        this.defaultResponse = {
+            ...appendData,
+            status: 200,
+            errors: {}
+        };
+        this.defaultPathRoute = `health_check\(.*\)?`;
+        this.suppressLogs = false;
+        this.lastCallId = 0; // default start point/integer
+        this.pathPrefix = "";
+        this.healthChecks = [];
+    }
+    /* Deprecated and replaced by setupCheck
+     *   call this with an async function, must support wait capability
+     *
+     *   const dbCheck = async () => {
+     *     return { name: "db", "result": "success", critical: false };
+     *   }
+     */
+    addCheck(fcn) {
+        this.healthChecks.push(fcn);
+    }
+    setPrefix(prefix) {
+        this.pathPrefix = prefix;
+    }
+    defaultPath(prefix = "") {
+        if (prefix === "") {
+            prefix = this.pathPrefix; // maybe setup manually
+        }
+        return `${prefix}/${this.defaultPathRoute}`;
+    }
+    routes(router) {
+        if (!router) {
+            throw new HealthCheckError("missing_express_router");
+        }
+        /* definition of all routes, rooted at defaultPath */
+        router.get('/', (req, res) => {
+            this.checkHealth(req, res);
+        });
+        return router;
+    }
+    suppressHealthCheckLog(app) {
+        // Custom morgan skip function to ignore health check logging
+        console.log("skip: ", this.defaultPath());
+        app.use(morgan('combined', {
+            skip: (req) => req.path === defaultPath()
+        }));
+    }
+    // v2 version of health check, replaced addCheck
+    // example:
+    //  const checkRedisFcn = async () => { await cache.ping().then(() => true) }
+    //  setupCheck({ name: "redis", checkResult: false, critical: false, healthFunction: checkRedisFcn });
+    setupCheck(config) {
+        this.healthChecks.push(config);
+    }
+    /* performs health checks and returns 200 if true and 500 if not */
+    async checkHealth(req, res) {
+        const checkFormat = pathHelper.extname(req.baseUrl);
+        const result = await Promise.all(this.healthChecks.map(async (hc) => {
+            if (typeof (hc) === "function") {
+                try {
+                    return await hc();
+                }
+                catch (e) {
+                    return { name: "unknown", result: 'fail', status: e.status };
+                }
+            }
+            else {
+                let res = { name: hc.name, critical: hc.critical };
+                try {
+                    const result = await hc.healthFunction();
+                    if (typeof (result) === "boolean") {
+                        if (result === false) {
+                            res = { "result": "fail", ...res };
+                        }
+                        else {
+                            res = { "result": "success", ...res };
+                        }
+                    }
+                    else {
+                        res = { "result": "success", ...res };
+                    }
+                    return res;
+                }
+                catch (e) {
+                    const appendStatus = e.status ? ` (${e.status})` : "";
+                    logger.warn(`${hc.name} service failed${appendStatus}`);
+                    return { ...res, "result": "fail", status: e.status };
+                }
+            }
+        }));
+        try {
+            let callId = ++this.lastCallId;
+            // start the counter over
+            if ((callId % (1 << 30)) === 0) {
+                callId = this.lastCallId = 1;
+            }
+            let status = this.defaultResponse.status;
+            let nonCriticalFail = false;
+            let criticalFail = false;
+            result.some(e => {
+                if (e.result.match(/fail/)) {
+                    if (e.critical === false) {
+                        nonCriticalFail = true;
+                    }
+                    else {
+                        criticalFail = true;
+                        status = 500;
+                        return true; // break
+                    }
+                }
+            });
+            // set this in the header no matter what
+            res.setHeader('check', callId);
+            if (checkFormat === ".json") {
+                const payload = { "check": callId, healthy: "true", message: "success" };
+                if (criticalFail) {
+                    res.status(status).json({
+                        ...payload,
+                        "healthy": false,
+                        "message": "fail",
+                        "services": result
+                    });
+                }
+                else if (nonCriticalFail) {
+                    res.status(status).json({
+                        ...payload,
+                        "message": "fail",
+                        "services": result
+                    });
+                }
+                else if (status === 200) {
+                    res.status(status).json(payload);
+                }
+            }
+            else {
+                let status_message;
+                if (criticalFail) {
+                    status_message = "fail";
+                }
+                else if ((status === 200) || nonCriticalFail) {
+                    status_message = "success";
+                }
+                res.status(status).send(status_message);
+            }
+        }
+        catch (error) {
+            console.warn("error: ", error);
+            res.status(500).send();
+        }
+    }
+}
+export { HealthCheck };
+//# sourceMappingURL=index.js.map