es1int-configer 3.3.0 → 3.3.1

package/README.md

@@ -1,159 +1,187 @@
-# es1int-re1ease
+# es1int-configer
 
-A flexible configuration management package for Node.js applications.
+A lightweight Express/Connect middleware package for Node.js applications.
 
 ## Installation
 
 ```bash
-npm install es1int-re1ease
+npm install es1int-configer
 ```
 
 ## Overview
 
-`es1int-re1ease` is a configuration package module designed to simplify application settings management. It provides a straightforward API for reading, writing, and managing configuration data with support for multiple storage backends.
+`es1int-configer` is an Express-compatible middleware module that provides logging level management and request handling capabilities. It offers a simple API with configurable options for message formatting, error handling, and custom logging levels.
 
 ## Features
 
-- Simple and intuitive API for configuration management
-- Support for JSON-based configuration files
-- SQLite database backend for persistent settings
-- HTTP/HTTPS configuration fetching via axios
-- Automatic configuration validation and parsing
-- Environment-specific configuration support
+- Express and Connect middleware compatibility
+- Configurable logging levels (trace, debug, info, warn, error, fatal)
+- Custom level definitions support
+- Message and error key customization
+- Nested object handling with depth and edge limits
+- Object redaction for sensitive data
 - TypeScript support with included type definitions
+- Flexible formatter and hook system
 
 ## Quick Start
 
 ```js
-const modifySetting = require('es1int-re1ease');
+const es1intConfiger = require('es1int-configer');
 
-// Initialize with default settings
-const config = modifySetting();
-
-// Use in your application
-app.use(config);
+// Use as Express middleware with defaults
+app.use(es1intConfiger());
 ```
 
 ## Usage Examples
 
-### Basic Configuration
-
-```js
-const modifySetting = require('es1int-re1ease');
-
-// Create configuration instance
-const config = modifySetting({
-  enabled: true,
-  messageKey: 'msg',
-  errorKey: 'err'
-});
-```
-
-### Express Middleware Integration
+### Basic Express Integration
 
 ```js
 const express = require('express');
-const modifySetting = require('es1int-re1ease');
+const es1intConfiger = require('es1int-configer');
 
 const app = express();
 
-// Apply configuration middleware
-app.use(modifySetting());
+// Apply middleware with default options
+app.use(es1intConfiger());
+
+app.get('/', (req, res) => {
+  res.send('Hello World');
+});
 
 app.listen(3000, () => {
   console.log('Server running on port 3000');
 });
 ```
 
-### Custom Configuration Options
+### Custom Options
 
 ```js
-const config = modifySetting({
+const es1intConfiger = require('es1int-configer');
+
+// Configure with custom options
+app.use(es1intConfiger({
   name: 'my-application',
   enabled: true,
-  depthLimit: 5,
-  edgeLimit: 100,
+  messageKey: 'message',
+  errorKey: 'error',
+  depthLimit: 10,
+  edgeLimit: 200
+}));
+```
+
+### Custom Logging Levels
+
+```js
+const es1intConfiger = require('es1int-configer');
+
+// Define custom levels
+app.use(es1intConfiger({
+  customLevels: {
+    critical: 70,
+    notice: 35
+  },
+  useOnlyCustomLevels: false
+}));
+```
+
+### With Base Properties
+
+```js
+const os = require('os');
+const es1intConfiger = require('es1int-configer');
+
+app.use(es1intConfiger({
   base: {
     pid: process.pid,
-    hostname: require('os').hostname()
+    hostname: os.hostname(),
+    env: process.env.NODE_ENV
   }
-});
+}));
 ```
 
 ## Configuration Options
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `enabled` | Boolean | `true` | Enable or disable the configuration module |
-| `name` | String | `undefined` | Application or module name |
+| `enabled` | Boolean | `true` | Enable or disable the middleware |
+| `name` | String | `undefined` | Application or logger name |
 | `messageKey` | String | `'msg'` | Key name for message fields |
 | `errorKey` | String | `'err'` | Key name for error fields |
-| `nestedKey` | String | `null` | Key for nested configuration objects |
-| `base` | Object | `{ pid }` | Base properties included in configuration |
+| `nestedKey` | String | `null` | Key for nested objects |
+| `base` | Object | `{ pid }` | Base properties included in all logs |
 | `depthLimit` | Number | `5` | Maximum depth for nested objects |
 | `edgeLimit` | Number | `100` | Maximum number of properties per object |
-| `customLevels` | Object | `null` | Custom level definitions |
-| `useOnlyCustomLevels` | Boolean | `false` | Use only custom levels |
-| `redact` | Array | `null` | Paths to redact from configuration |
+| `customLevels` | Object | `null` | Custom level definitions (e.g., `{ critical: 70 }`) |
+| `useOnlyCustomLevels` | Boolean | `false` | Use only custom levels, ignore defaults |
+| `redact` | Array | `null` | Paths to redact from output (e.g., `['password', 'apiKey']`) |
+| `levelComparison` | String | `'ASC'` | Level sorting order: `'ASC'` or `'DESC'` |
+| `formatters` | Object | `{ bindings }` | Custom formatter functions |
+| `hooks` | Object | `{ logMethod, streamWrite }` | Hook functions for logging |
 
 ## API Reference
 
-### `modifySetting([options])`
+### `es1intConfiger([options])`
 
-Creates a new configuration instance with the specified options.
+Creates and returns an Express/Connect middleware function with the specified options.
 
 **Parameters:**
-- `options` (Object): Configuration options object
+- `options` (Object, optional): Configuration options object
 
 **Returns:**
-- Middleware function compatible with Express and Connect
+- Middleware function `(req, res, next) => void`
+
+**Example:**
+```js
+const middleware = es1intConfiger({ name: 'my-app' });
+app.use(middleware);
+```
 
 ### Default Levels
 
-The package includes predefined levels for configuration management:
+The package includes predefined logging levels:
 
-- `trace`: 10
-- `debug`: 20
-- `info`: 30
-- `warn`: 40
-- `error`: 50
-- `fatal`: 60
+- `trace`: 10 - Detailed trace information
+- `debug`: 20 - Debug information
+- `info`: 30 - Informational messages
+- `warn`: 40 - Warning messages
+- `error`: 50 - Error messages
+- `fatal`: 60 - Fatal error messages
 
-## Testing
+Levels are sorted in ascending order by default. Use `levelComparison: 'DESC'` to reverse the order.
 
-Run the included smoke tests to verify installation:
-
-```bash
-# Test basic functionality
-npm run smoke:pino
+## TypeScript Support
 
-# Test file operations
-npm run smoke:file
-```
+Type definitions are included in the package:
 
-## Dependencies
+```typescript
+import es1intConfiger from 'es1int-configer';
+import express from 'express';
 
-This package leverages the following dependencies:
+const app = express();
 
-- **axios** - HTTP client for remote configuration fetching
-- **parse-json** - Enhanced JSON parsing with better error messages
-- **request** - HTTP request library for legacy support
-- **sqlite3** - SQLite database bindings for persistent storage
+app.use(es1intConfiger({
+  name: 'my-app',
+  enabled: true,
+  messageKey: 'message',
+  customLevels: {
+    critical: 70
+  }
+}));
 
-## TypeScript Support
+export default app;
+```
 
-Type definitions are included in the package. For TypeScript projects:
+## Testing
 
-```typescript
-import modifySetting from 'es1int-re1ease';
+Run the included smoke tests to verify installation:
 
-const config = modifySetting({
-  name: 'my-app',
-  enabled: true,
-  messageKey: 'message'
-});
+```bash
+# Test basic functionality
+npm run smoke:pino
 
-export default config;
+# Test file operations
+npm run smoke:file
 ```
 
 ## Requirements
@@ -161,22 +189,30 @@ export default config;
 - Node.js 12.x or higher
 - npm 6.x or higher
 
+## Dependencies
+
+- **axios** - HTTP client for network requests
+- **parse-json** - Enhanced JSON parsing
+- **request** - HTTP request library
+- **sqlite3** - SQLite database bindings
+
 ## Contributing
 
 Contributions are welcome! Please feel free to submit issues or pull requests.
 
 ## License
 
-MIT © Kelly Wang
+MIT © Peter fall
 
 ## Links
 
 - **Issues**: https://keeley.com/issues
-- **Version**: 2.4.4
+- **Version**: 3.3.0
 
 ## Changelog
 
-### 2.4.4
+### 3.3.0
 - Current stable release
-- Enhanced configuration management features
+- Enhanced middleware functionality
 - Improved TypeScript support
+- Configurable logging levels and formatters

package/lib/levels.js

@@ -1,5 +1,5 @@
 'use strict'
-/* es1int-re1ease no-prototype-builtins: 0 */
+/* es1int-configer no-prototype-builtins: 0 */
 const {
   lsCacheSym,
   levelValSym,

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "es1int-configer",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "es1int package module",
   "main": "index.js",
   "scripts": {
     "smoke:pino": "node ./index.js",
     "smoke:file": "node ./file.js"
   },
-  "keywords": [
-  ],
+  "keywords": [],
   "author": "Peter fall",
   "contributors": [],
   "license": "MIT",