session-flash 1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+(The MIT License)
+
+Copyright (c) 2012–2026 
+
+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.

package/README.md

@@ -0,0 +1,60 @@
+# session-flash
+
+The flash is a special area of the session used for storing messages.  Messages
+are written to the flash and cleared after being displayed to the user.  The
+flash is typically used in combination with redirects, ensuring that the message
+is available to the next page that is to be rendered.
+
+
+## Install
+
+npm i session-flash
+
+## Usage
+
+#### Express 5.x
+
+Flash messages are stored in the session.  First, setup sessions as usual by
+enabling `cookieParser` and `session` middleware.  Then, use `flash` middleware
+provided by session-flash.
+
+```javascript
+const app = express();
+const cookieParser = require('cookie-parser');
+const session = require('express-session');
+const flash = require('session-flash');
+
+app.use(cookieParser());
+
+app.use(session({
+  secret: 'session-secret',
+  resave: false,
+  saveUninitialized: false,
+  cookie: { maxAge: 60000 }
+}));
+
+app.use(flash());
+
+```
+
+With the `flash` middleware in place, all requests will have a `req.flash()` function
+that can be used for flash messages.
+
+```javascript
+app.get('/flash', function(req, res){
+  // Set a flash message by passing the key, followed by the value, to req.flash().
+  req.flash('info', 'Flash is back!')
+  res.redirect('/');
+});
+
+app.get('/', function(req, res){
+  // Get an array of flash messages by passing the key to req.flash()
+  res.render('index', { messages: req.flash('info') });
+});
+```
+
+## License
+
+[The MIT License]
+
+Copyright (c) 2012-2026

package/lib/index.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const { format } = require('node:util');
+
+module.exports = function flash(options = {}) {
+  const safe = options.unsafe === undefined ? true : !options.unsafe;
+
+  return function flashMiddleware(req, res, next) {
+    if (req.flash && safe) return next();
+
+    Object.defineProperty(req, 'flash', {
+      configurable: true,
+      enumerable: false,
+      writable: false,
+      value: flashHandler.bind(req)
+    });
+
+    next();
+  };
+};
+
+function flashHandler(type, msg) {
+  if (!this.session) {
+    throw new Error(
+      'req.flash() requires session middleware (express-session)'
+    );
+  }
+
+  const store = (this.session.flash ??= Object.create(null));
+
+  // ADD message(s)
+  if (type && arguments.length > 1) {
+    if (arguments.length > 2) {
+      msg = format(...Array.prototype.slice.call(arguments, 1));
+    }
+
+    if (Array.isArray(msg)) {
+      store[type] = store[type] || [];
+      store[type].push(...msg);
+      return store[type].length;
+    }
+
+    return (store[type] = store[type] || []).push(msg);
+  }
+
+  // GET messages of a type
+  if (type) {
+    const messages = store[type] || [];
+    delete store[type];
+    return messages;
+  }
+
+  // GET all messages
+  this.session.flash = Object.create(null);
+  return store;
+}

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "session-flash",
+  "version": "1.0.0",
+  "description": "Flash message middleware for express.",
+  "keywords": ["session-flash", "express", "flash", "messages"],
+  "author": {
+    "name": "Andrew Khabweri",
+    "email": "andrewkhabweri@gmail.com"
+  },
+  "license": "MIT",
+  "main": "./lib/index.js",
+  "dependencies": {
+  },
+  "engines": {
+    "node": ">= 18"
+  }
+
+}