session-flash 1.0.10 → 1.0.12

package/.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - 18
+  - 20
+  - 22

package/lib/flash.js

@@ -1,7 +1,7 @@
 /**
  * Module dependencies.
  */
-const { format } = require('util');
+var format = require('util').format;
 
 /**
  * Expose `flash()` function on requests.
@@ -11,14 +11,14 @@ const { format } = require('util');
  */
 module.exports = function flash(options) {
   options = options || {};
-  const safe = options.unsafe === undefined ? true : !options.unsafe;
-
+  var safe = (options.unsafe === undefined) ? true : !options.unsafe;
+  
   return function(req, res, next) {
-    if (req.flash && safe) return next();
+    if (req.flash && safe) { return next(); }
     req.flash = _flash;
     next();
-  };
-};
+  }
+}
 
 /**
  * Queue flash `msg` of the given `type`.
@@ -41,45 +41,38 @@ module.exports = function flash(options) {
  *
  * Formatting:
  *
- * Flash notifications support 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);
  *
- * Uses `util.format()`.
+ * Formatting uses `util.format()`, which is available on Node 0.6+.
  *
  * @param {String} type
- * @param {String|Array} msg
+ * @param {String} msg
  * @return {Array|Object|Number}
  * @api public
  */
 function _flash(type, msg) {
-  if (!this.session) throw new Error('req.flash() requires sessions');
-
-  const msgs = this.session.flash = this.session.flash || {};
-
-  if (type && msg !== undefined) {
-    // Format message if multiple arguments
-    if (arguments.length > 2) {
-      const args = Array.from(arguments).slice(1);
-      msg = format(...args);
-    }
-
-    // Handle array of messages
-    if (Array.isArray(msg)) {
-      msgs[type] = msgs[type] || [];
-      msg.forEach(val => msgs[type].push(val));
+  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;
     }
-
-    // Handle single message
-    msgs[type] = msgs[type] || [];
-    return msgs[type].push(msg);
-
+    return (msgs[type] = msgs[type] || []).push(msg);
   } else if (type) {
-    const arr = msgs[type] || [];
+    var arr = msgs[type];
     delete msgs[type];
-    return arr;
-
+    return arr || [];
   } else {
     this.session.flash = {};
     return msgs;

package/lib/index.d.ts

@@ -1,47 +1,19 @@
-import * as express from 'express';
+/// <reference types="express" />
 
-/**
- * Options for flash middleware
- */
-export interface FlashOptions {
-  /**
-   * If true, middleware will not override existing req.flash
-   * Default: true
-   */
-  unsafe?: boolean;
-}
-
-/**
- * Augment Express Request interface to include flash
- */
-declare global {
-  namespace Express {
-    interface Request {
-      /**
-       * Flash messages.
-       * 
-       * Usage:
-       *   req.flash('info', 'message')
-       *   req.flash('info')
-       *   req.flash()
-       */
-      flash(type: string, msg: string | string[], ...args: any[]): number;
-      flash(type: string): string[];
-      flash(): Record<string, string[]>;
+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;
     }
+}
 
-    interface Session {
-      flash?: Record<string, string[]>;
+declare module "session-flash" {
+    import express = require("express");
+    interface IConnectFlashOptions {
+        unsafe?: boolean | undefined;
     }
-  }
+    function e(options?: IConnectFlashOptions): express.RequestHandler;
+    export = e;
 }
-
-/**
- * Flash middleware factory
- * 
- * @param options FlashOptions
- * @returns Express middleware
- */
-declare function flash(options?: FlashOptions): express.RequestHandler;
-
-export = flash;

package/package.json

@@ -1,45 +1,37 @@
 {
   "name": "session-flash",
-  "version": "1.0.10",
-  "description": "Flash message middleware for Session.",
+  "version": "1.0.12",
+  "description": "Flash message middleware for Express sessions",
   "keywords": [
     "session",
     "express",
     "flash",
     "messages"
   ],
-  "author": {
-    "name": "Andrew Khabweri",
-    "email": "andrewkhabweri@gmail.com"
-  },
+  "author": "Andrew Khabweri <andrewkhabweri@gmail.com>",
+  "license": "MIT",
   "type": "commonjs",
-  "licenses": [
-    {
-      "type": "MIT"
-    }
-  ],
-  "main": "./lib",
+  "main": "./lib/index.js",
   "exports": {
     ".": {
       "require": "./lib/index.js",
       "types": "./lib/index.d.ts"
     }
   },
-  "files": [
-    "lib"
-  ],
   "dependencies": {},
   "peerDependencies": {
     "express": ">=4",
     "express-session": ">=1.15"
   },
   "devDependencies": {
-    "vows": "0.8.x"
+    "mocha": "^10.2.0",
+    "supertest": "^6.3.3",
+    "chai": "^4.3.7"
   },
   "scripts": {
-    "test": "NODE_PATH=lib node_modules/.bin/vows test/*-test.js"
+    "test": "mocha 'test/**/*.test.js'"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=18"
   }
 }