2.0.20

license

@@ -0,0 +1,19 @@
+Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

npmextra.json

@@ -1,4 +1,15 @@
 {
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartlog",
+      "shortDescription": "minimalistic distributed and extensible logging tool",
+      "npmPackagename": "@pushrocks/smartlog",
+      "license": "MIT",
+      "projectDomain": "push.rocks"
+    }
+  },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"

package.json

@@ -1,25 +1,33 @@
 {
   "name": "@pushrocks/smartlog",
-  "version": "2.0.14",
+  "version": "2.0.20",
   "private": false,
-  "description": "winston based logger for large scale projects",
+  "description": "minimalistic distributed and extensible logging tool",
+  "keywords": [
+    "logging",
+    "centralized logging",
+    "json logging",
+    "scalyr",
+    "elasticsearch",
+    "logdna"
+  ],
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "author": "Lossless GmbH",
-  "license": "UNLICENSED",
+  "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.4",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.18",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^10.12.18",
+    "@types/node": "^12.11.2",
-    "tslint": "^5.12.1",
+    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.17.0"
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
     "@pushrocks/smartlog-interfaces": "^2.0.5"

readme.md

@@ -1,25 +1,19 @@
 # @pushrocks/smartlog
+minimalistic distributed and extensible logging tool
 
-winston based logger for large scale projects
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartlog)
-## Availabililty
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartlog)
-
+* [github.com (source mirror)](https://github.com/pushrocks/smartlog)
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartlog)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartlog/)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartlog)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartlog)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartlog/)
 
 ## Status for master
-
+[![build status](https://gitlab.com/pushrocks/smartlog/badges/master/build.svg)](https://gitlab.com/pushrocks/smartlog/commits/master)
-[![build status](https://GitLab.com/pushrocks/smartlog/badges/master/build.svg)](https://GitLab.com/pushrocks/smartlog/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartlog/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartlog/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartlog/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartlog/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartlog.svg)](https://www.npmjs.com/package/@pushrocks/smartlog)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartlog.svg)](https://www.npmjs.com/package/smartlog)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartlog/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartlog)
-[![Dependency Status](https://david-dm.org/pushrocks/smartlog.svg)](https://david-dm.org/pushrocks/smartlog)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartlog/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartlog/master/dependencies/npm)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartlog/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartlog)
-[![Known Vulnerabilities](https://snyk.io/test/npm/smartlog/badge.svg)](https://snyk.io/test/npm/smartlog)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
@@ -32,10 +26,10 @@ smartlog id s minimal logging package that provides a consistent experience acro
 import { Smartlog } from '@pushrocks/smartlog';
 const logger = new Smartlog({
   {
-    company?: 'My awesome company',
+    company: 'My awesome company',
-    companyunit?: 'my awesome cloud team',
+    companyunit: 'my awesome cloud team',
-    containerName?: 'awesome-container',
+    containerName: 'awesome-container',
-    environment: TEnvironment: 'kubernetes-production',
+    environment: 'kubernetes-production',
     runtime: 'node',
     zone: 'zone x'
   }
@@ -47,7 +41,7 @@ logger.log('silly', `a silly statement`); // log levels are shown to you by the
 There is also a default logger available that you can use:
 
 ```ts
-import {Smartlog, defaultLogger } from '@pushrocks/smartlog';
+import { Smartlog, defaultLogger } from '@pushrocks/smartlog';
 
 export class MyAwesomeClass {
   constructor(public logger: Smartlog = defaultLogger) {
@@ -58,24 +52,26 @@ export class MyAwesomeClass {
 ```
 
 ### Destinations
+
 smartlog supports different kinds of destinations.
 
 The following destinations are available:
 
-* [@pushrocks/smartlog-destination-local](https://www.npmjs.com/package/@pushrocks/smartlog-destination-local) - outputs logs to the local console in a colorful, nice to read way.
+- [@pushrocks/smartlog-destination-local](https://www.npmjs.com/package/@pushrocks/smartlog-destination-local) - outputs logs to the local console in a colorful, nice to read way.
-* [@pushrocks/smartlog-destination-devtools](https://www.npmjs.com/package/@pushrocks/smartlog-destination-devtools) - outputs logs into the browser console in a colorful, nice to read way.
+- [@pushrocks/smartlog-destination-devtools](https://www.npmjs.com/package/@pushrocks/smartlog-destination-devtools) - outputs logs into the browser console in a colorful, nice to read way.
-* [@pushrocks/smartlog-destination-receiver](https://www.npmjs.com/package/@pushrocks/smartlog-destination-receiver) - sends logs to a smartlog receiver (more about that below)
+- [@pushrocks/smartlog-destination-receiver](https://www.npmjs.com/package/@pushrocks/smartlog-destination-receiver) - sends logs to a smartlog receiver (more about that below)
-* [@mojoio/scalyr](https://www.npmjs.com/package/@pushrocks/smartlog-destination-receiver) - an scalyr API package that comes with a smartlog log destination included
+- [@mojoio/scalyr](https://www.npmjs.com/package/@pushrocks/smartlog-destination-receiver) - an scalyr API package that comes with a smartlog log destination included
-* [@mojoio/elasticsearch](https://www.npmjs.com/package/@mojoio/elasticsearch) - an elasticsearch API package that comes with a smartlog destination included
+- [@mojoio/elasticsearch](https://www.npmjs.com/package/@mojoio/elasticsearch) - an elasticsearch API package that comes with a smartlog destination included
 
 ### Adding a log destination
+
 ```
 // TBD
 ```
 
-For further information read the linked docs at the top of this README.
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
 [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

ts/smartlog.classes.smartlog.ts

@@ -1,32 +1,21 @@
 import * as plugins from './smartlog.plugins';
 
-// interfaces
-import {
-  TLogType,
-  TEnvironment,
-  ILogContext,
-  TLogLevel,
-  TRuntime,
-  ILogDestination,
-  ILogPackage
-} from '@pushrocks/smartlog-interfaces';
-
 import { LogRouter } from './smartlog.classes.logrouter';
 
 export interface ISmartlogContructorOptions {
-  logContext: ILogContext;
+  logContext: plugins.smartlogInterfaces.ILogContext;
-  minimumLogLevel?: TLogLevel;
+  minimumLogLevel?: plugins.smartlogInterfaces.TLogLevel;
 }
 
 export class Smartlog {
-  private logContext: ILogContext;
+  private logContext: plugins.smartlogInterfaces.ILogContext;
-  private minimumLogLevel: TLogLevel;
+  private minimumLogLevel: plugins.smartlogInterfaces.TLogLevel;
 
   private consoleEnabled: boolean;
 
   private logRouter = new LogRouter();
 
-  public addLogDestination(logDestinationArg: ILogDestination) {
+  public addLogDestination(logDestinationArg: plugins.smartlogInterfaces.ILogDestination) {
     this.logRouter.addLogDestination(logDestinationArg);
   }
 
@@ -42,7 +31,7 @@ export class Smartlog {
   /**
    * enables console logging
    */
-  enableConsole() {
+  public enableConsole() {
     this.consoleEnabled = true;
   }
 
@@ -55,11 +44,13 @@ export class Smartlog {
    * @param logMessageArg - the log message
    * @param logDataArg - any additional log data
    */
-  public log(logLevelArg: TLogLevel, logMessageArg: string, logDataArg?: any) {
+  public log(logLevelArg: plugins.smartlogInterfaces.TLogLevel, logMessageArg: string, logDataArg?: any) {
     if (this.consoleEnabled) {
-      console.log(`LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`);
+      console.log(
+        `LOG => ${new Date().getHours()}:${new Date().getMinutes()}:${new Date().getSeconds()} => ${logLevelArg}: ${logMessageArg}`
+      );
     }
-    const logPackage: ILogPackage = {
+    const logPackage: plugins.smartlogInterfaces.ILogPackage = {
       timestamp: Date.now(),
       type: 'log',
       context: this.logContext,
@@ -72,7 +63,7 @@ export class Smartlog {
     this.logRouter.routeLog(logPackage);
   }
 
-  public increment(logLevelArg: TLogLevel, logMessageArg) {
+  public increment(logLevelArg: plugins.smartlogInterfaces.TLogLevel, logMessageArg) {
     if (this.consoleEnabled) {
       console.log(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
     }
@@ -85,7 +76,7 @@ export class Smartlog {
     });
   }
 
-  public handleLogPackage(logPackageArg: ILogPackage) {
+  public handleLogPackage(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
     this.logRouter.routeLog(logPackageArg);
   }
 }

ts/smartlog.plugins.ts

@@ -1 +1,5 @@
-export {};
+import * as smartlogInterfaces from '@pushrocks/smartlog-interfaces';
+
+export {
+  smartlogInterfaces
+};