session-flash 1.0.11 → 1.0.13

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2012-2013 Jared Hanson
+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

package/README.md

@@ -1,36 +1,42 @@
-# connect-flash
+# 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.
 
-This middleware was extracted from [Express](http://expressjs.com/) 2.x, after
-Express 3.x removed direct support for the flash.  connect-flash brings this
-functionality back to Express 3.x, as well as any other middleware-compatible
-framework or application. +1 for [radical reusability](http://substack.net/posts/b96642/the-node-js-aesthetic).
 
 ## Install
 
-    $ npm install connect-flash
+npm i session-flash
 
 ## Usage
 
-#### Express 3.x
+#### 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 connect-flash.
+provided by session-flash.
 
 ```javascript
-var flash = require('connect-flash');
-var app = express();
+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());
+
+
 
-app.configure(function() {
-  app.use(express.cookieParser('keyboard cat'));
-  app.use(express.session({ cookie: { maxAge: 60000 }}));
-  app.use(flash());
-});
 ```
 
 With the `flash` middleware in place, all requests will have a `req.flash()` function
@@ -49,25 +55,8 @@ app.get('/', function(req, res){
 });
 ```
 
-## Examples
-
-For an example using connect-flash in an Express 3.x app, refer to the [express3](https://github.com/jaredhanson/connect-flash/tree/master/examples/express3)
-example.
-
-## Tests
-
-    $ npm install --dev
-    $ make test
-
-[![Build Status](https://secure.travis-ci.org/jaredhanson/connect-flash.png)](http://travis-ci.org/jaredhanson/connect-flash)
-
-## Credits
-
-  - [Jared Hanson](http://github.com/jaredhanson)
-  - [TJ Holowaychuk](https://github.com/visionmedia)
-
 ## License
 
-[The MIT License](http://opensource.org/licenses/MIT)
+[The MIT License]
 
-Copyright (c) 2012-2013 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>
+Copyright (c) 2012-2026

package/lib/index.d.ts

@@ -1,19 +1,38 @@
 /// <reference types="express" />
 
-declare namespace Express {
-    export interface Request {
-        flash(): { [key: string]: string[] };
-        flash(message: string): string[];
-        flash(type: string, message: string[] | string): number;
-        flash(type: string, format: string, ...args: any[]): number;
-    }
+import 'express';
+
+declare module 'express-serve-static-core' {
+  interface Request {
+    /**
+     * Get all flash messages and clear them
+     */
+    flash(): Record<string, string[]>;
+
+    /**
+     * Get messages of a specific type and clear them
+     */
+    flash(type: string): string[];
+
+    /**
+     * Add one or more flash messages
+     */
+    flash(type: string, message: string | string[]): number;
+
+    /**
+     * Add a formatted flash message (util.format)
+     */
+    flash(type: string, format: string, ...args: any[]): number;
+  }
 }
 
-declare module "session-flash" {
-    import express = require("express");
-    interface IConnectFlashOptions {
-        unsafe?: boolean | undefined;
-    }
-    function e(options?: IConnectFlashOptions): express.RequestHandler;
-    export = e;
+declare module 'session-flash' {
+  import { RequestHandler } from 'express';
+
+  interface FlashOptions {
+    unsafe?: boolean;
+  }
+
+  const flash: (options?: FlashOptions) => RequestHandler;
+  export = flash;
 }

package/lib/index.js

@@ -1,4 +1,57 @@
-/**
- * Expose middleware.
- */
-exports = module.exports = require('./flash');
+'use strict';
+
+const { format } = require('node:util');
+
+module.exports = function flash(options) {
+  options = options || {};
+
+  const safe = options.unsafe === undefined
+    ? true
+    : !options.unsafe;
+
+  return function flashMiddleware(req, res, next) {
+    if (req.flash && safe) {
+      return next();
+    }
+
+    req.flash = _flash;
+    next();
+  };
+};
+
+function _flash(type, msg) {
+  if (this.session === undefined) {
+    throw new Error('req.flash() requires sessions');
+  }
+
+  const flash = this.session.flash || (this.session.flash = {});
+
+  // SET
+  if (type && msg !== undefined) {
+    // util.format support
+    if (arguments.length > 2) {
+      msg = format.apply(null, Array.prototype.slice.call(arguments, 1));
+    }
+
+    // Array support
+    if (Array.isArray(msg)) {
+      msg.forEach(val => {
+        (flash[type] = flash[type] || []).push(val);
+      });
+      return flash[type].length;
+    }
+
+    return (flash[type] = flash[type] || []).push(msg);
+  }
+
+  // GET by type
+  if (type) {
+    const msgs = flash[type];
+    delete flash[type];
+    return msgs || [];
+  }
+
+  // GET all
+  this.session.flash = {};
+  return flash;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "session-flash",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "Flash message middleware for Express sessions",
   "keywords": [
     "session",

package/lib/flash.js

@@ -1,80 +0,0 @@
-/**
- * Module dependencies.
- */
-var format = require('util').format;
-
-/**
- * Expose `flash()` function on requests.
- *
- * @return {Function}
- * @api public
- */
-module.exports = function flash(options) {
-  options = options || {};
-  var safe = (options.unsafe === undefined) ? true : !options.unsafe;
-  
-  return function(req, res, next) {
-    if (req.flash && safe) { return next(); }
-    req.flash = _flash;
-    next();
-  }
-}
-
-/**
- * Queue flash `msg` of the given `type`.
- *
- * Examples:
- *
- *      req.flash('info', 'email sent');
- *      req.flash('error', 'email delivery failed');
- *      req.flash('info', 'email re-sent');
- *      // => 2
- *
- *      req.flash('info');
- *      // => ['email sent', 'email re-sent']
- *
- *      req.flash('info');
- *      // => []
- *
- *      req.flash();
- *      // => { error: ['email delivery failed'], info: [] }
- *
- * Formatting:
- *
- * Flash notifications also support arbitrary formatting support.
- * For example you may pass variable arguments to `req.flash()`
- * and use the %s specifier to be replaced by the associated argument:
- *
- *     req.flash('info', 'email has been sent to %s.', userName);
- *
- * Formatting uses `util.format()`, which is available on Node 0.6+.
- *
- * @param {String} type
- * @param {String} msg
- * @return {Array|Object|Number}
- * @api public
- */
-function _flash(type, msg) {
-  if (this.session === undefined) throw Error('req.flash() requires sessions');
-  var msgs = this.session.flash = this.session.flash || {};
-  if (type && msg) {
-    // util.format is available in Node.js 0.6+
-    if (arguments.length > 2 && format) {
-      var args = Array.prototype.slice.call(arguments, 1);
-      msg = format.apply(undefined, args);
-    } else if (Array.isArray(msg)) {
-      msg.forEach(function(val){
-        (msgs[type] = msgs[type] || []).push(val);
-      });
-      return msgs[type].length;
-    }
-    return (msgs[type] = msgs[type] || []).push(msg);
-  } else if (type) {
-    var arr = msgs[type];
-    delete msgs[type];
-    return arr || [];
-  } else {
-    this.session.flash = {};
-    return msgs;
-  }
-}