Merge stmp

Author: Romakita

docs/.vuepress/config.js

@@ -47,7 +47,8 @@ module.exports = {
                   { link: '/appenders/file.html', text: 'File', items: [] },
                   { link: '/appenders/file-date.html', text: 'File date', items: [] },
                   { link: '/appenders/stdout.html', text: 'Stdout', items: [] },
-                  { link: '/appenders/stderr.html', text: 'Stderr', items: [] }
+                  { link: '/appenders/stderr.html', text: 'Stderr', items: [] },
+                  { link: '/appenders/smtp.html', text: 'Smtp', items: [] }
                 ]
               },
               {
@@ -100,7 +101,8 @@ module.exports = {
                 'file',
                 'file-date',
                 'stdout',
-                'stderr'
+                'stderr',
+                'smtp'
               ]
             },
             {
@@ -146,6 +148,7 @@ module.exports = {
           '/appenders/file-date',
           '/appenders/stdout',
           '/appenders/stderr',
+          '/appenders/smtp',
           '/layouts/basic',
           '/layouts/colored',
           '/layouts/dummy',

docs/appenders/file.md

@@ -24,6 +24,7 @@ implementation (see also node.js core file streams):
 - **compress** - boolean (default false) - compress the backup files during rolling (backup files will have .gz extension)
 
 ## Example
+
 ```typescript
 import {Logger} from "@tsed/logger";
 

docs/appenders/smtp.md

@@ -0,0 +1,116 @@
+# SMTP Appender
+
+Sends log events as emails. If you use this appender, you should also call `logger.shutdown` when your application closes so that any remaining emails can be sent. Many of the configuration options below are passed through to nodemailer, so you should read their docs to get the most out of this appender.
+
+```bash
+npm install @tsed/logger
+npm install @tsed/logger-smtp
+```
+
+## Configuration
+
+* `type` - `smtp`
+* `SMTP` - `object` (optional, if not present will use `transport` field)
+  * `host` - `string` (optional, defaults to `localhost`)
+  * `port` - `integer` (optional, defaults to `25`)
+  * `auth` - `object` (optional) - authentication details
+    * `user` - `string`
+    * `pass` - `string`
+* `transport` - `object` (optional, if not present will use `SMTP`) - see [`nodemailer`](https://nodemailer.com/smtp/) docs for transport options
+  * `plugin` - `string` (optional, defaults to `smtp`) - the nodemailer transport plugin to use
+  * `options` - `object` - configuration for the transport plugin
+* `attachment` - `object` (optional) - send logs as email attachment
+  * `enable` - `boolean` (optional, defaults to `false`)
+  * `message` - `string` (optional, defaults to `See logs as attachment`) - message to put in body of email
+  * `filename` - `string` (optional, defaults to `default.log`) - attachment filename
+* `sendInterval` - `integer` (optional, defaults to `0`) - batch emails and send in one email every `sendInterval` seconds, if `0` then every log message will send an email.
+* `shutdownTimeout` - `integer` (optional, defaults to `5`) - time in seconds to wait for emails to be sent during shutdown
+* `recipients` - `string` - email addresses to send the logs to
+* `subject` - `string` (optional, defaults to message from first log event in batch) - subject for email
+* `sender` - `string` (optional) - who the logs should be sent as
+* `html` - `boolean` (optional, defaults to `false`) - send the email as HTML instead of plain text
+* `layout` - `object` (optional, defaults to basicLayout) - see [layouts](https://logger.tsed.io/layouts.html)
+* `cc` - `string` (optional) - email addresses to send the carbon-copy logs to
+* `bcc` - `string` (optional) - email addresses to send the blind-carbon-copy logs to
+
+## Example (default config)
+
+```typescript
+import {Logger} from "@tsed/logger";
+import "@tsed/logger-smtp"
+
+const logger = new Logger("loggerName");
+
+logger.appenders.set("email", {
+  type: "smtp", 
+  level: ["error"],
+  recipients: "dev.team@company.name"
+});
+```
+
+This configuration will send an email using the smtp server running on `localhost:25`, for every log event of level `ERROR` and above. 
+The email will be sent to `dev.team@company.name`, the subject will be the message part of the log event, the body of the email will be log event formatted by the basic layout function.
+
+## Example (logs as attachments, batched)
+
+```typescript
+import {Logger} from "@tsed/logger";
+import "@tsed/logger-smtp"
+
+const logger = new Logger("loggerName");
+
+logger.appenders.set("email", {
+  type: "smtp", 
+  level: ["error"],
+  recipients: "dev.team@company.name",
+  subject: "Latest logs",
+  sender: "my.application@company.name",
+  attachment: {
+    enable: true,
+    filename: "latest.log",
+    message: "See the attachment for the latest logs"
+  },
+  sendInterval: 3600
+});
+```
+
+This configuration will send an email once every hour, with all the log events of level `ERROR` and above as an attached file.
+
+## Example (custom SMTP host)
+
+```javascript
+import {Logger} from "@tsed/logger";
+import "@tsed/logger-smtp"
+
+const logger = new Logger("loggerName");
+
+logger.appenders.set("email", {
+  type: "smtp", 
+  level: ["error"],
+  recipients: "dev.team@company.name",
+  SMTP: { host: 'smtp.company.name', port: 8025 }
+});
+```
+
+This configuration can also be written as:
+
+```javascript
+import {Logger} from "@tsed/logger";
+import "@tsed/logger-smtp"
+
+const logger = new Logger("loggerName");
+
+logger.appenders.set("email", {
+  type: "smtp", 
+  level: ["error"],
+  recipients: "dev.team@company.name",
+  transport: {
+    plugin: 'smtp',
+    options: {
+      host: 'smtp.company.name',
+      port: 8025
+    }
+  }
+});
+```
+A similar config can be used to specify a different transport plugin than `smtp`. See the [`nodemailer`](https://nodemailer.com/smtp/) docs for more details.

packages/logger/src/appenders/decorators/appender.ts

@@ -8,6 +8,7 @@ import {IAppenderOptions} from "../class/BaseAppender";
 export function Appender(options: IAppenderOptions) {
   return (target: any) => {
     target.prototype.appenderOptions = options;
+    target.$name = options.name;
     AppendersRegistry.set(options.name, {provide: target});
   };
 }

packages/logger/src/appenders/index.ts

@@ -1,75 +1,8 @@
-/**
- * ## Appenders
- *
- * Appenders serialise log events to some form of output. They can write to files, send emails, send data over the network. All appenders have a type which determines which appender gets used. For example:
- *
- * ```typescript
- * import {Logger} from "ts-log-debug";
- *
- * const logger = new Logger("loggerName");
- *
- * logger.appenders
- *   .push({
- *       type: "stdout", level: ["debug", "info", "trace"]
- *   })
- *   .push({
- *       type: "stderr", level: ["error", "fatal", "warn"]
- *   });
- *   .push({
- *       type: "file", filename: "logfile.log"
- *   });
- * ```
- *
- * This defines three appenders named ‘stdout’, ‘stderr’ and ‘file’.
- *
- * ### Core Appenders
- *
- * The following appenders are included with ts-log-debug.
- *
- * * console
- * * file
- * * stderr
- * * stdout
- *
- * ### Custom Appender
- *
- * ts-log-debug can load appenders from outside the core appenders. The type config value is used as a require path if no matching appender can be found. For example, the following configuration will create an appender with decorators:
- *
- * ```typescript
- * // consoleAppender.ts
- * import {Appender, BaseAppender, LogEvent} from "ts-log-debug";
- * const consoleLog = console.log.bind(console);
- *
- *  &arobase;Appender({name: "console2"})
- * export class ConsoleAppender extends BaseAppender {
- *   write(loggingEvent: LogEvent) {
- *       consoleLog(this.layout(loggingEvent, this.config.timezoneOffset));
- *   }
- * }
- * ```
- *
- * This appender can be use like this:
- *
- * ```typescript
- * import {Logger} from "ts-log-debug";
- * import "./consoleAppender.ts"
- *
- * const logger = new Logger("loggerName");
- *
- * logger.appenders
- *   .push({
- *       type: "console2", level: ["debug", "info", "trace"]
- *   });
- * ```
- *
- * @module appenders
- * @preferred
- */
-/** */
-import "./components/ConsoleAppender";
-import "./components/FileAppender";
-import "./components/StderrAppender";
-import "./components/StdoutAppender";
+export * from "./components/ConsoleAppender";
+export * from "./components/FileAppender";
+export * from "./components/StderrAppender";
+export * from "./components/StdoutAppender";
 
+export * from "./interfaces/AppenderConfiguration";
 export * from "./class/BaseAppender";
 export * from "./decorators/appender";

packages/logger/src/index.ts

@@ -1,21 +1,3 @@
-/**
- * @preferred
- *
- * @fileoverview ts-log-debug is a library to log in TypeScript.
- *
- * <h3>Example:</h3>
- * <pre>
- * import {$log} from "ts-log-debug";
- * $log.level = "debug";
- * $log.name = "APP";
- * $log.debug("Some debug messages");
- * </pre>
- *
- * @author Lenzotti Romain
- * @since 2017-06-18
- * @static
- * Website:
- */
 export * from "./core";
 export * from "./appenders";
 export * from "./layouts";

packages/logger/src/layouts/class/Layouts.ts

@@ -1,18 +1,19 @@
-/**
- * @module layouts
- */
-/** */
 import {LayoutsRegistry} from "../registries/LayoutsRegistry";
 import {IBasicLayoutConfiguration} from "../interfaces/BasicLayoutConfiguration";
+import {BaseLayout} from "./BaseLayout";
 
 export class Layouts {
-  static get(name: string, config: IBasicLayoutConfiguration) {
+  static get(name: string | any, config: IBasicLayoutConfiguration): BaseLayout {
+    if (typeof name !== "string") {
+      name = name.$name;
+    }
+
     if (!LayoutsRegistry.has(name)) {
       name = "colored";
       console.warn(name + " layout doesn't exists");
     }
 
-    const layoutKlass: any = LayoutsRegistry.get(name.replace(/layout/gi, ""));
+    const layoutKlass: any = LayoutsRegistry.get(name);
 
     return new layoutKlass.provide(config);
   }

packages/logger/src/layouts/decorators/layout.ts

@@ -2,6 +2,7 @@ import {LayoutsRegistry} from "../registries/LayoutsRegistry";
 
 export function Layout(options: {name: string}) {
   return (target: any) => {
+    target.$name = options.name;
     LayoutsRegistry.set(options.name, {provide: target});
   };
 }