Merge pull request #178 from SAP/fix-types

Improve TypeScript compatibility

Author: christiand93

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cf-nodejs-logging-support",
-  "version": "7.0.0-beta.5",
+  "version": "7.0.0-beta.6",
   "description": "Logging tool for Cloud Foundry",
   "keywords": [
     "logging",

package.json

@@ -1,5 +1,10 @@
-import RootLogger from "./lib/logger/rootLogger"
+import RootLogger from "./lib/logger/rootLogger";
 
 const rootLogger = RootLogger.getInstance();
 
-export = rootLogger
+module.exports = rootLogger; // assign default export
+exports = module.exports; // re-assign exports
+
+export default rootLogger;
+export * from "./lib/config/interfaces";
+export * from "./lib/logger/level";

src/index.ts

@@ -23,10 +23,10 @@ export default class Config {
 
     private config: ConfigObject = {
         "fields": [],
-        "customFieldsFormat": CustomFieldsFormat.default,
+        "customFieldsFormat": CustomFieldsFormat.Default,
         "reqLoggingLevel": "info",
         "outputStartupMsg": false,
-        "framework": Framework.express
+        "framework": Framework.Express
     }
 
     private constructor() {
@@ -56,11 +56,11 @@ export default class Config {
             }
 
             if (boundServices["application-logs"] && boundServices["cloud-logging"]) {
-                Config.instance.setCustomFieldsFormat(CustomFieldsFormat.all);
+                Config.instance.setCustomFieldsFormat(CustomFieldsFormat.All);
             } else if (boundServices["application-logs"]) {
-                Config.instance.setCustomFieldsFormat(CustomFieldsFormat.applicationLogging);
+                Config.instance.setCustomFieldsFormat(CustomFieldsFormat.ApplicationLogging);
             } else {
-                Config.instance.setCustomFieldsFormat(CustomFieldsFormat.cloudLogging);
+                Config.instance.setCustomFieldsFormat(CustomFieldsFormat.CloudLogging);
             }
 
             Config.instance.addConfig(configFiles);
@@ -181,11 +181,11 @@ export default class Config {
                     field._meta.isCache = true;
                 }
 
-                if (field.output?.includes(Output.msgLog)) {
+                if (field.output?.includes(Output.MsgLog)) {
                     this.addToList(this.msgFields, field);
                 }
 
-                if (field.output?.includes(Output.reqLog)) {
+                if (field.output?.includes(Output.ReqLog)) {
                     this.addToList(this.reqFields, field);
                 }
 
@@ -196,10 +196,10 @@ export default class Config {
                 }
 
                 if (field._meta.isCache == false) {
-                    if (field.output?.includes(Output.msgLog)) {
+                    if (field.output?.includes(Output.MsgLog)) {
                         this.addToList(this.noCacheMsgFields, field);
                     }
-                    if (field.output?.includes(Output.reqLog)) {
+                    if (field.output?.includes(Output.ReqLog)) {
                         this.addToList(this.noCacheReqFields, field);
                     }
                 }
@@ -309,9 +309,9 @@ export default class Config {
         for (let i in sources) {
             let source = sources[i]
             switch (source.type) {
-                case SourceType.static:
+                case SourceType.Static:
                     return true;
-                case SourceType.env:
+                case SourceType.Env:
                     // if this is the last source it does not matter, if the env var exists
                     if (i == (sources.length - 1).toString()) return true
 

src/lib/config/config.ts

@@ -40,52 +40,52 @@ export interface ConfigFieldMeta {
 }
 
 export enum Framework {
-    express = "express",
-    restify = "restify",
-    connect = "connect",
-    nodejsHttp = "plainhttp"    
+    Express = "express",
+    Restify = "restify",
+    Connect = "connect",
+    NodeJsHttp = "plainhttp"    
 }
 
 export enum Output {
-    msgLog = "msg-log",
-    reqLog = "req-log"
+    MsgLog = "msg-log",
+    ReqLog = "req-log"
 }
 
 export enum CustomFieldsFormat {
-    applicationLogging = "application-logging",
-    cloudLogging = "cloud-logging",
-    all = "all",
-    disabled = "disabled",
-    default = "default"
+    ApplicationLogging = "application-logging",
+    CloudLogging = "cloud-logging",
+    All = "all",
+    Disabled = "disabled",
+    Default = "default"
 }
 
 export enum SourceType {
-    static = "static",
-    env = "env",
-    configField = "config-field",
-    reqHeader = "req-header",
-    resHeader = "res-header",
-    reqObject = "req-object",
-    resObject = "res-object",
-    detail = "detail",
-    uuid = "uuid"
+    Static = "static",
+    Env = "env",
+    ConfigField = "config-field",
+    ReqHeader = "req-header",
+    ResHeader = "res-header",
+    ReqObject = "req-object",
+    ResObject = "res-object",
+    Detail = "detail",
+    UUID = "uuid"
 }
 
 export enum DetailName {
-    requestReceivedAt = "requestReceivedAt",
-    responseSentAt = "responseSentAt",
-    responseTimeMs = "responseTimeMs",
-    writtenAt = "writtenAt",
-    writtenTs = "writtenTs",
-    message = "message",
-    stacktrace = "stacktrace",
-    level = "level"
+    RequestReceivedAt = "requestReceivedAt",
+    ResponseSentAt = "responseSentAt",
+    ResponseTimeMs = "responseTimeMs",
+    WrittenAt = "writtenAt",
+    WrittenTs = "writtenTs",
+    Message = "message",
+    Stacktrace = "stacktrace",
+    Level = "level"
 }
 
 
 export enum Conversion {
-    toString = "toString",
-    parseInt = "parseInt",
-    parseFloat = "parseFloat",
-    parseBoolean = "parseBoolean"
+    ToString = "toString",
+    ParseInt = "parseInt",
+    ParseFloat = "parseFloat",
+    ParseBoolean = "parseBoolean"
 }

src/lib/config/interfaces.ts

@@ -1,11 +1,12 @@
-import Level from '../logger/level';
+import { Level } from '../logger/level';
 
 export default class LevelUtils {
 
-    private static readonly defaultLevel: Level = Level.INFO
+    private static readonly defaultLevel: Level = Level.Info
 
     static getLevel(name: string): Level {
-        const level: Level = Level[name.toUpperCase() as keyof typeof Level]
+        const key = name.charAt(0).toUpperCase() + name.slice(1).toLowerCase();
+        const level: Level = Level[key as keyof typeof Level]
         if (level === undefined) {
             return LevelUtils.defaultLevel;
         }
@@ -17,7 +18,7 @@ export default class LevelUtils {
     }
 
     static isLevelEnabled(threshold: Level, level: Level) {
-        if (level <= Level.OFF) return false;
+        if (level <= Level.Off) return false;
         return level <= threshold
     }
 }

src/lib/helper/levelUtils.ts

@@ -26,15 +26,15 @@ export default class Cache {
 
     getCacheMsgRecord(cacheFields: ConfigField[]): any {
         if (this.shouldUpdateMsg) {
-            this.updateCache(Output.msgLog, cacheFields);
+            this.updateCache(Output.MsgLog, cacheFields);
             this.shouldUpdateMsg = false;
         }
         return this.cacheMsgRecord;
     }
 
     getCacheReqRecord(cacheFields: ConfigField[], req: any, res: any): any {
         if (this.shouldUpdateReq) {
-            this.updateCache(Output.reqLog, cacheFields, req, res);
+            this.updateCache(Output.ReqLog, cacheFields, req, res);
             this.shouldUpdateReq = false;
         }
         return this.cacheReqRecord;
@@ -48,7 +48,7 @@ export default class Cache {
     private updateCache(output: Output, cacheFields: ConfigField[], req?: any, res?: any) {
         let cache: any = {};
 
-        if (output == Output.msgLog) {
+        if (output == Output.MsgLog) {
             this.cacheMsgRecord = {};
             cache = this.cacheMsgRecord;
         } else {

src/lib/logger/cache.ts

@@ -1,12 +1,10 @@
-enum Level {
-    INHERIT = -2,
-    OFF = -1,
-    ERROR = 0,
-    WARN = 1,
-    INFO = 2,
-    VERBOSE = 3,
-    DEBUG = 4,
-    SILLY = 5
+export enum Level {
+    Inherit = -2,
+    Off = -1,
+    Error = 0,
+    Warn = 1,
+    Info = 2,
+    Verbose = 3,
+    Debug = 4,
+    Silly = 5
 }
-
-export default Level