struct-logger 0.0.1-security → 1.0.7

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,269 @@
-# Security holding package
+# Simple Node Logger
+```
+ __ _                 _            __          _          __                             
+/ _(_)_ __ ___  _ __ | | ___    /\ \ \___   __| | ___    / /  ___   __ _  __ _  ___ _ __ 
+\ \| | '_ ` _ \| '_ \| |/ _ \  /  \/ / _ \ / _` |/ _ \  / /  / _ \ / _` |/ _` |/ _ \ '__|
+_\ \ | | | | | | |_) | |  __/ / /\  / (_) | (_| |  __/ / /__| (_) | (_| | (_| |  __/ |   
+\__/_|_| |_| |_| .__/|_|\___| \_\ \/ \___/ \__,_|\___| \____/\___/ \__, |\__, |\___|_|   
+               |_|                                                 |___/ |___/           
+```
 
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
+[![NPM version](https://badge.fury.io/js/simple-node-logger.svg)](http://badge.fury.io/js/simple-node-logger) [![Build Status](https://travis-ci.org/darrylwest/simple-node-logger.svg?branch=master)](https://travis-ci.org/darrylwest/simple-node-logger) [![Dependency Status](https://david-dm.org/darrylwest/simple-node-logger.svg)](https://david-dm.org/darrylwest/simple-node-logger)
 
-Please refer to www.npmjs.com/advisories?search=struct-logger for more information.
+A simple multi-level logger for console, file, and rolling file appenders.  Features include:
+
+- levels: trace, debug, info, warn, error and fatal levels (plus all and off)
+- flexible appender/formatters with default to HH:mm:ss.SSS LEVEL message
+- add appenders to send output to console, file, rolling file, etc
+- change log levels on the fly
+- domain and category columns
+- overridable format methods in base appender
+- stats that track counts of all log statements including warn, error, etc
+- ability to configure to emit process error event for central trapping
+
+## Installation
+
+`npm install simple-node-logger --save`
+
+
+## How to use
+```javascript
+// create a stdout console logger
+const log = require('simple-node-logger').createSimpleLogger();
+```
+
+or
+
+```javascript
+// create a stdout and file logger
+const log = require('simple-node-logger').createSimpleLogger('project.log');
+```
+
+or
+
+```javascript
+// create a custom timestamp format for log statements
+const SimpleNodeLogger = require('simple-node-logger'),
+	opts = {
+		logFilePath:'mylogfile.log',
+		timestampFormat:'YYYY-MM-DD HH:mm:ss.SSS'
+	},
+log = SimpleNodeLogger.createSimpleLogger( opts );
+```
+
+or
+
+```javascript
+// create a file only file logger
+const log = require('simple-node-logger').createSimpleFileLogger('project.log');
+```
+
+or
+
+```javascript
+// create a rolling file logger based on date/time that fires process events
+const opts = {
+	errorEventName:'error',
+        logDirectory:'/mylogfiles', // NOTE: folder must exist and be writable...
+        fileNamePattern:'roll-<DATE>.log',
+        dateFormat:'YYYY.MM.DD'
+};
+const log = require('simple-node-logger').createRollingFileLogger( opts );
+```
+
+or
+
+```javascript
+// create a log manager
+const manager = require('simple-node-logger').createLogManager();
+    
+manager.createConsoleAppender();
+    
+const log = manager.createLogger('MyClass');
+// create other logs and appenders...
+```
+
+The first use simply logs to the console.  The second logs to the console and to the project.log file.  The third create a console logger with a custom timestamp format. The fourth logs to the file only. The fifth creates a rolling file log system in the target log folder.  The fifth creates a log manager to enable you to add various appenders with multiple levels and create logs for each module or class.
+
+*See the examples folder for in depth samples...*
+
+## Log Levels
+
+The log levels include the standard set: trace, debug, info, warn, error and fatal.  The default level is info.  The log level can be set at run-time by doing this:
+
+```javascript
+log.setLevel('warn');
+```
+
+This sets the log level to warn and suppresses debug and info messages.
+
+## Log Statement Formats
+
+### Simple Logger
+
+The default format is HH:mm:ss.SSS LEVEL message. For example, the log message:
+
+```javascript
+log.info('subscription to ', channel, ' accepted at ', new Date().toJSON());
+```
+
+Yields:
+
+`14:14:21.363 INFO  subscription to /devchannel accepted at 2014-04-10T14:20:52.938Z`
+	
+### Category Logger
+
+If you create a logger with a category name, all log statements will include this category.  Typically a category is a class or module name.  If you create a logger with the category name 'MyCategory', the log statement would format like this:
+
+`14:14:21.363 INFO  MyCategory subscription to /devchannel accepted at 2014-04-10T14:20:52.938Z`
+	 
+## Appenders
+
+You can create a single logger / log manager and add multiple appenders with different log levels.  For example, you can add a console appender that has a log level of warn and a file appender to debug. 
+
+_See examples/category-logger.js for an example_.
+
+### Console
+
+Writes to the console.  This is the simplest appender typically used for command line applications or for development.
+
+### File
+
+Writes to the specified file.  This appender is typically used for services that periodically start and stop or that have a limited number of log statements.  An example would be to log just error & fatal messages separate from other logs.
+
+### Rolling File Appender
+
+The rolling file appender offers a full production logger where files roll based on date and time.  The minimum roll time is a single hour.  A typical application would be a production environment where log files are rolled throughout the day then archived to a separate location.
+
+The rolling file appender requires a valid date format and file name pattern.  The filename must contain the key word <DATE> that will be replaced with the formatted date.  The configuration must also include a target log directory where the files will be written.
+
+#### Valid Filename Patterns
+
+```
+mylog-<DATE>.log
+ApplicationName.log.<DATE>
+<DATE>.log
+<DATE>
+```
+
+#### Valid Date Formats
+
+Date formats must map to acceptable file names so have more restrictions than typical dates.  If you use delimiters, you are restricted to a dash or dot delimiter to separate year, month, day and hour.  Valid examples include:
+
+```
+MMDD  // simple month day that rolls at midnight (no delimiters)
+YYYY.MM.DD-HH // year month day and hour that can roll up to once per hour
+YYYY-MM-DD.a // year month day and am/pm that rolls twice per day
+YYYY-MMM-DD // year month day where month is the short name (Mar, Apr, etc)
+```
+
+The default format YYYY.MM.DD is used if the format is not supplied.
+
+## Dynamic Configuration
+
+Create a javascript configuration that implements 'readConfig' to return configuration details.  
+
+## Examples
+
+The examples folder includes a handful of simple to not so simple cases for console, file, multi-appender, category, etc.
+
+## Customizations
+
+### Appenders
+
+Adding a new appender is as easy as implementing write( logEntry ).  The easiest way to implement is by extending the base class AbstractAppender.  You may also easily override the formatting, order, etc by overriding or providing your own abstract or concrete appender.
+
+For example, you can extend the AbstractAppender to create a JSON appender by doing this:
+
+```javascript
+    const AbstractAppender = require('simple-node-logger').AbstractAppender;
+
+    const JSONAppender = function() {
+    	'use strict';
+    	var appender = this;
+    	
+        var opts = {
+            typeName:'JSONAppender'
+        };
+        
+        AbstractAppender.extend( this, opts );
+        
+        // format and write all entry/statements
+        this.write = function(entry) {
+        	var fields = appender.formatEntry( entry );
+        	
+        	process.stdout.write( JSON.stringify( entry ) + '\n' );
+        };
+    };
+```
+
+### Overrides
+
+#### Appenders
+
+The appenders have formatting messages that can be overridden at the abstract or concrete level.  The format methods include:
+
+- formatEntry(entry) - to override all formatting
+- formatMessage(msgList) - to override a list of messages
+- formatDate(value) - custom date, defaults to ISO8601
+- formatObject(value) - custom object, defaults to json for regular objects
+
+#### Logger
+
+It's easy to extend any one of the log methods at the instance level.  Here is an example of overriding the error log to send a socket message:
+
+```javascript
+const log = new require('simple-node-logger').createSimpleLogger();
+const socket = openWebSocket();
+
+// override the standard error method to send a socket message
+log.error = function() {
+    var args = Array.prototype.slice.call( arguments ),
+        entry = log.log('error', args);
+
+    // now do something special with the log entry...
+    process.nextTick(function() {
+    	socket.send( JSON.stringify( entry ));
+    });
+};
+```
+
+
+## Tests
+
+All unit tests are written in mocha/chai/should and can be run from the command line by doing this:
+
+`make test`
+	
+There is also a file watcher that can be invoked with this:
+
+`make watch`
+	
+	
+## Mocks
+
+Mocks used for testing include MockLogger and MockAppender.  Typically you would use MockLogger for unit tests like this:
+
+```javascript
+    const MockLogger = require('simple-node-logger').mocks.MockLogger;
+
+    const log = MockLogger.createLogger('MyCategory');
+
+    log.info('this is a log statement');
+    log.getLogEntries().length.should.equal( 1 );
+```
+
+MockLogger extends Logger and uses MockAppender to capture log entries.
+
+## License
+
+Apache 2.0
+
+## Recent updates...
+
+* 0.93.29: when an Error object is logged, the message and stack trace are sent to log targets
+* 0.93.30: fixed example/category-logger.js and examples/domain-logger.js to not double-log
+* 0.93.31: added thisArg to methods in AbstractAppender to enable proper binding and full override when extending
+
+- - -
+<p><small><em>Copyright © 2014-2019, rain city software | Version 18.12.24</em></small></p>